HP Scripting Toolkit for Windows 9.60 User Manual

HP Scripting Toolkit for Windows 9.60 User Guide

Abstract

This document provides information about the Scripting Toolkit for Windows utilities and how best to use the Scripting Toolkit for Windows to configure HP ProLiant servers and BladeSystem infrastructure in a Windows environment. This document is intended for IT experts with experience in scripting operating system installations and configuring HP ProLiant server hardware.

HP Part Number: 722152-003 Published: February 2014 Edition: 1

Notices

The information contained herein is subject to change without notice. The only warranties for HP products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. HP shall not be liable for technical or editorial errors or omissions contained herein.

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.

Microsoft, Windows, Windows Server, and Windows Vista are U.S. registered trademarks of Microsoft Corporation. Intel is a trademark of Intel Corporation in the U.S. and other countries.

1 Introduction...............................................................................................6

Scripting Toolkit for Windows.....................................................................................................6

Microsoft Windows Preinstallation Environment.............................................................................6

Minimum requirements..............................................................................................................6

2 Deployment using the Scripting Toolkit for Windows.......................................7

Deployment overview................................................................................................................7

Sample deployment procedure...................................................................................................7

Creating a network share......................................................................................................8

Adding drivers to Windows PE 3.0.........................................................................................8

Adding drivers to Windows PE 4.0........................................................................................9

Capturing a reference configuration from the source server......................................................10

Configuring the target server and installing the operating system .............................................11

3 Advanced topics......................................................................................12

Overview..............................................................................................................................12

Customizing deployment scripts using HPDISCOVERY and IFHW..................................................12

Querying the HPDISCOVERY file based on system name ........................................................12

Querying the HPDISCOVERY file to determine the presence of a particular card ........................12

Querying the HPDISCOVERY file to determine the presence of a card family..............................13

Booting Windows PE from a USB drive key................................................................................13

Flashing the ROM in a Windows PE environment........................................................................13

Erasing array configurations.....................................................................................................15

4 Scripting Toolkit utilities.............................................................................16

Syntax conventions.................................................................................................................16

Utility online help...................................................................................................................16

Using Scripting Toolkit utilities..................................................................................................16

Using REBOOT.......................................................................................................................17

REBOOT command-line syntax.............................................................................................17

REBOOT command-line arguments.......................................................................................17

REBOOT return codes.........................................................................................................17

REBOOT command-line examples........................................................................................18

Using SETBOOTORDER...........................................................................................................18

SETBOOTORDER command-line syntax.................................................................................18

SETBOOTORDER command-line arguments...........................................................................18

SETBOOTORDER return codes.............................................................................................18

SETBOOTORDER command-line examples.............................................................................18

Using STATEMGR...................................................................................................................19

STATEMGR command-line syntax.........................................................................................19

STATEMGR command-line arguments....................................................................................19

STATEMGR return codes.....................................................................................................19

STATEMGR command-line examples.....................................................................................19

Using RBSURESET...................................................................................................................19

RBSURESET command-line syntax.........................................................................................20

RBSURESET command-line arguments...................................................................................20

RBSURESET return codes.....................................................................................................20

Using HPDISCOVERY..............................................................................................................20

HPDISCOVERY command-line syntax....................................................................................20

HPDISCOVERY command line arguments..............................................................................20

HPDISCOVERY return codes................................................................................................21

HPDISCOVERY command line examples...............................................................................21

Using IFHW...........................................................................................................................21

Contents 3

IFHW command-line syntax.................................................................................................21

IFHW command-line arguments...........................................................................................22

IFHW return codes.............................................................................................................22

IFHW command line examples............................................................................................22

Expression operators and terms...........................................................................................22

Expression examples..........................................................................................................23

Using HWQUERY...................................................................................................................23

HWQUERY command-line syntax.........................................................................................23

HWQUERY command line arguments...................................................................................23

HWQUERY return codes.....................................................................................................24

HWQUERY command-line examples....................................................................................24

Using CONREP......................................................................................................................24

CONREP command-line syntax............................................................................................25

CONREP command-line arguments......................................................................................25

CONREP return codes........................................................................................................25

CONREP screen output.......................................................................................................26

CONREP -s (Store to Data file) ............................................................................................26

CONREP –l (Load from Data File).........................................................................................26

CONREP Data File Sample Contents for HP ProLiant servers not using the Oxx ROM family.........27

CONREP command file contents..........................................................................................28

Using HPRCU.........................................................................................................................28

HPRCU command-line syntax...............................................................................................29

HPRCU command line arguments.........................................................................................29

HPRCU return codes...........................................................................................................29

HPRCU sample XML format.................................................................................................29

Using HPSSASCRIPTING..........................................................................................................30

Capturing a configuration...................................................................................................30

Using an Input script...........................................................................................................31

Creating an HP SSA script file.............................................................................................31

Sample custom input script.............................................................................................31

Script file options...............................................................................................................33

Control category...........................................................................................................34

Action mode............................................................................................................34

Method mode..........................................................................................................34

Controller category.......................................................................................................34

Controller................................................................................................................35

ChassisName..........................................................................................................35

ClearConfigurationWithDataLoss................................................................................35

LicenseKey, DeleteLicenseKey.....................................................................................35

PreferredPathMode...................................................................................................35

ReadCache, WriteCache...........................................................................................36

RebuildPriority, ExpandPriority....................................................................................36

SSPState..................................................................................................................36

SurfaceScanDelay....................................................................................................37

Video performance options........................................................................................37

Array category.............................................................................................................37

Array......................................................................................................................37

Drive.......................................................................................................................37

DriveType................................................................................................................38

OnlineSpare............................................................................................................38

Logical Drive category...................................................................................................38

ArrayAccelerator......................................................................................................39

LogicalDrive.............................................................................................................39

LogicalDriveSSPState.................................................................................................39

ParityGroups............................................................................................................39

4 Contents

PreferredPath...........................................................................................................39

RAID.......................................................................................................................39

Sectors....................................................................................................................40

Size........................................................................................................................40

SSPAdaptersWithAccess............................................................................................40

StripeSize................................................................................................................40

HBA category...............................................................................................................41

ConnectionName.....................................................................................................41

HBA_WW_ID..........................................................................................................41

HostMode...............................................................................................................41

HP SSA scripting error messages..........................................................................................41

Using HPLPCFG......................................................................................................................45

HPLPCFG command-line syntax............................................................................................45

HPLPCFG command-line arguments......................................................................................45

HPLPCFG return codes........................................................................................................46

HPLPCFG command-line examples.......................................................................................46

Using LO100CFG...................................................................................................................47

LO100CFG command-line syntax.........................................................................................47

LO100CFG command-line arguments...................................................................................47

LO100CFG return codes.....................................................................................................47

LO100CFG command-file contents.......................................................................................48

Using HPQLAREP...................................................................................................................48

HPQLAREP command-line syntax.........................................................................................48

HPQLAREP command-line arguments....................................................................................49

HPQLAREP return codes......................................................................................................49

HPQLAREP command-line examples.....................................................................................50

Using HPONCFG...................................................................................................................50

HPONCFG command-line syntax.........................................................................................50

HPONCFG command-line arguments...................................................................................50

HPONCFG return codes.....................................................................................................51

HPONCFG command file contents.......................................................................................51

Obtaining an entire configuration....................................................................................51

Obtaining a specific configuration...................................................................................52

Setting a configuration...................................................................................................53

HPONCFG command-line examples.....................................................................................53

5 Troubleshooting........................................................................................54

Troubleshooting table..............................................................................................................54

6 Support and other resources......................................................................55

Information to collect before contacting HP.................................................................................55

How to contact HP..................................................................................................................55

Subscription service................................................................................................................55

Related information.................................................................................................................55

Scripting Toolkit support..........................................................................................................55

Typographic conventions.........................................................................................................56

HP Insight Remote Support software..........................................................................................56

HP Insight Online...................................................................................................................56

7 Documentation feedback...........................................................................58

Acronyms and abbreviations.........................................................................59

Index.........................................................................................................61

Contents 5

1 Introduction

Scripting Toolkit for Windows

The Scripting Toolkit for Windows is a server deployment product that delivers an unattended automated installation for high-volume HP ProLiant server and BladeSystem infrastructure deployments. This document describes how to best use the Scripting Toolkit to configure HP ProLiant servers and BladeSystem infrastructure. It also contains information about the Scripting Toolkit utilities and how to use them in an unattended environment. This document does not include information about installing the operating system.

The Scripting Toolkit is designed for IT experts with experience in scripting operating system installations and configuring HP ProLiant and BladeSystem infrastructure server hardware.

CAUTION: Improper use of the Scripting Toolkit utilities can result in loss of critical data. Because

of the potential data-loss risk, only experienced individuals should use the Scripting Toolkit utilities. Before using the Scripting Toolkit, all necessary precautions must be taken to ensure that mission-critical systems remain online if a failure occurs.

NOTE: This release of the Scripting Toolkit uses Smart Storage Administrator (HP SSA), instead

of the Array Configuration Utility (ACU). HP SSA includes all of the functions previously contained in ACU.

Microsoft Windows Preinstallation Environment

Microsoft Windows Preinstallation Environment (Windows PE) is a small footprint of the Windows Server environment that enables you to run tools in a 32- or 64-bit Windows environment. Because Windows PE is based on the Windows kernel running in protected mode, only a subset of features and APIs are available in this environment. This document is applicable to Windows PE 3.0 and

4.0 only, and is not backward compatible with previous versions of Windows PE. Windows PE enables you to install the Windows operating system, establish a connection with

network servers, and perform hardware configuration using the Scripting Toolkit. You can use Windows PE to customize and configure your servers before the operating system is installed.

To obtain Windows PE 3.0, download the Microsoft Windows Automated Installation Kit for Windows 7 and Windows Server 2008 R2 from the Microsoft website at http://www.microsoft.com.

To obtain Windows PE 4.0, download the Microsoft Windows Assessment and Deployment Kit for Windows 8 and Windows Server 2012 from the Microsoft website at http://www.microsoft.com.

Minimum requirements

Before beginning the deployment process, be sure to have the following items available:

• HP Scripting Toolkit for Windows

• HP Scripting Toolkit for Windows User Guide

• Microsoft Windows Automated Installation Kit for Windows 7 and Server 2008 R2 (for the

creation of Windows PE 3.0) or Microsoft Windows Assessment and Deployment Kit for Windows 8 and Windows Server 2012 (for the creation of Windows PE 4.0).

• The operating system to be deployed (Windows Server 2008 R2, Windows Server 2012 or

6 Introduction

Windows Server 2012 R2)

2 Deployment using the Scripting Toolkit for Windows

Deployment overview

The Scripting Toolkit includes a set of utilities for configuring and deploying servers in a customized, predictable, and unattended manner. These utilities enable you to duplicate the configuration of a source server on target servers with minimal user interaction.

IMPORTANT: HP ProLiant 100-Series servers previous to Gen8 do not support all Scripting Toolkit

commands, and those that are supported might not work as expected. For example, SETBOOTORDER might behave differently on these systems. For a better understanding, read the server documentation carefully.

You can perform server deployments in many different ways using the Scripting Toolkit, but you must include the following steps in every deployment:

1. Create a network share.

2. Prepare the bootable media (CD/DVD, USB drive key, or PXE).

3. Configure the system and storage hardware on the target server.

4. Install the operating system.

5. Update the drivers and agents as needed.

IMPORTANT: Not all options can be configured using Scripting Toolkit utilities. Some options

must be configured manually or with other configuration utilities, which are available online, before they can be used with the Scripting Toolkit. For more information on configuration, see the option documentation.

Sample deployment procedure

The following procedure is a case study of a typical deployment. This procedure assumes that you are performing a media-based installation and that you want to replicate an existing server configuration. The process described in this section can vary depending on your specific requirements.

This section provides a simple overview of a basic deployment, but the flexibility of the Scripting Toolkit enables you to do much more. With an understanding of the basic steps and your own deployment environment, you can use the Scripting Toolkit to further customize and automate the deployment process. For information on automating deployments, see “Advanced topics” (page

12).

Deployment overview 7

Creating a network share

To create a network share:

1. Download the appropriate Scripting Toolkit package from the Scripting Toolkit website at

http://www.hp.com/go/ProLiantSTK.

2. Install the Scripting Toolkit package on a common server that resides on the same network as the servers to be deployed.

3. Share the folder in which you installed the Scripting Toolkit. Be sure that the account you use has read and write access.

4. Create an empty directory called \DATA in the Scripting Toolkit folder for configuration files. Captured files are stored in this directory.

HP also recommends installing the latest version of the HP Service Pack for ProLiant (SPP). To obtain the most current SPP, see the SPP website at http://www.hp.com/go/spp.

Adding drivers to Windows PE 3.0

The Scripting Toolkit contains HP drivers that are to be used with Windows PE 3.0. These drivers are located in the drivers directory of the Scripting Toolkit. Run the executable file in this directory, and then select Extract to extract the drivers to a location to be used in the following steps.

8 Deployment using the Scripting Toolkit for Windows

is installed and the STK IO driver (hpsstkio.sys) is copied to the windows\system32\ drivers directory.

To add drivers offline:

1. Mount the base image to a local directory by using dism. For example:

dism /Mount-Wim /WimFile:C:\winpe_x86\winpe.wim /index:1 MountDir:C:\STK.TMP

2. Add the .inf file to the base image by using the dism /Add-Driver command. For example:

dism /image:C:\SSSTK.TMP /Add-Driver /driver:C:\ssstk\drivers\example.inf

3. For each additional device driver repeat steps 1 and 2. When you finish customizing the image, prepare the image for deployment by using the peimg /prep command.

NOTE: If the appropriate iLO driver is not installed, some utilities do not work correctly. For

more information, see the README.txt file located with the drivers.

To add drivers online:

1. Use the drvload tool, drvload.exe inf_path, where inf_path is the path to a device driver INF file.

drvload x:\drivers\example.inf

2. Copy and then paste the STK IO driver to the windows\system32\drivers directory.

NOTE: If the HPSTKIO.SYS driver is not installed, some utilities do not work correctly.

copy c:\ssstk\drivers\system\ hpsstkio\ hpsstkio.sys c:\SSSTK.TMP\ windows\system32\drivers

For more information about Windows PE 3.0, see the Windows Preinstallation Environment User's Guide (WinPE.chm) located in the Windows Automated Installation Kit.

For more information about the Windows PE drivers included in the Scripting Toolkit for Windows (STK), see the readme.txt file located at the root of the Windows PE driver bundle in the drivers directory.

NOTE: Before running HPDISCOVERY, you must install WMI. For more information on installing

extra packages in Windows PE, see the Windows PE documentation.

Adding drivers to Windows PE 4.0

The Scripting Toolkit contains HP drivers that are to be used with Windows PE 4.0. These drivers are located in the drivers directory of the Scripting Toolkit. Run the executable file in this directory, and then select Extract to extract the drivers to a location to be used in the following steps.

Drivers can be added to Windows PE either offline or online. For all the utilities to work correctly, complete the following steps to ensure the appropriate iLO driver (based on OS and version number) is installed and the STK IO driver (hpsstkio.sys) is copied to the windows\system32\ drivers directory.

To add drivers offline:

1. Mount the base image to a local directory by using dism. For example:

dism /Mount-Wim /WimFile:C:\winpe_x86\winpe.wim /index:1 MountDir:C:\STK.TMP

2. Add the .inf file to the base image by using the dism /Add-Driver command. For example:

dism /image:C:\SSSTK.TMP /Add-Driver /driver:C:\ssstk\drivers\example.inf

Sample deployment procedure 9

3. For each additional device driver repeat steps 1 and 2. When you finish customizing the image, prepare the image for deployment by using the peimg /prep command.

NOTE: If the appropriate iLO driver is not installed, some utilities do not work correctly. For

more information, see the README.txt file located with the drivers.

To add drivers online:

1. Use the drvload tool, drvload.exe inf_path, where inf_path is the path to a device driver INF file.

drvload x:\drivers\example.inf

2. Copy and then paste the STK IO driver to the windows\system32\drivers directory.

NOTE: If the HPSTKIO.SYS driver is not installed, some utilities do not work correctly.

copy c:\ssstk\drivers\system\ hpsstkio\ hpsstkio.sys c:\SSSTK.TMP\ windows\system32\drivers

For more information about Windows PE 4.0, see the Windows Advanced Deployment Guide for System Builders located in the Microsoft Windows Assessment and Deployment Kit for Windows

8 and Windows Server 2012. For more information about the Windows PE drivers included in the Scripting Toolkit for Windows,

see the readme.txt file located at the root of the Windows PE driver bundle in the drivers directory.

NOTE: Before running HPDISCOVERY, you must install WMI. For more information on installing

extra packages in Windows PE, see the Windows PE documentation.

Capturing a reference configuration from the source server

1. Boot the media (CD/DVD, USB drive key, or PXE) that contains the customized Windows PE image on the source server.

2. Open a command window.

3. Capture the system settings from the source server using the CONREP utility: a. Change to the directory where CONREP resides. b. Save the current system configuration to a data file in the \data directory you created

on the network share:

conrep -s -fs:\data\filename

Choose a file name that is descriptive of the source server; for instance, dl380g3.xml.

4. Capture the storage settings: a. Change to the directory in which HPSSASCRIPTING resides. b. Save the current array configuration to a data file in the \data directory you created on

the network share:

hpssascripting -c s:\data\filename

Choose a file name that is descriptive of the source array; for instance, dl380g3array.ini.

5. Verify that the new output files are present in the \data directory.

You cannot capture and apply iLO settings using HPONCFG in the same fashion as CONREP and HPSSASCRIPTING. For more information, see “Using HPONCFG” (page 50).

IMPORTANT: Because the -w argument does not capture certain types of information, such as

the administrator password, data files created with HPONCFG using the -w argument cannot then be used as input files for HPONCFG, unless they are modified first.

10 Deployment using the Scripting Toolkit for Windows

Configuring the target server and installing the operating system

1. Boot the media (CD/DVD, USB drive key, or PXE) that contains the customized Windows PE image on the target server.

2. Run CONREP to configure the target server with the captured settings: a. Change to the directory where CONREP resides. b. Apply the captured configuration to the target server:

conrep -l -fs:\data\filename

3. Run HPSSASCRIPTING to configure the storage of the target server with the captured settings: a. Change to the directory where HPSSASCRIPTING resides. b. Apply the captured configuration to the target array:

bin \hpssascripting.exe -i s:\data\filename

4. (Optional) Configure the iLO option. HP recommends that you set these parameters: a. Edit the sample iLOconfig.xml file that is provided with the Scripting Toolkit so that

it contains the appropriate password and other required information. For more information,

see the "Using HPONCFG" section. b. Copy the edited iLOconfig.xml file to s:\data. c. Change to the directory where HPONCFG resides. d. Configure the iLO option:

hponcfg -f s:\data\iLOconfig.xml

5. Insert the operating system DVD.

6. Reboot to run the operating system installation. For information on automated, unattended installation, see the following resources:

• Operating system documentation

• Windows Server Technical Reference at http://technet.microsoft.com/en-us/library/

bb625087.aspx

Sample deployment procedure 11

3 Advanced topics

Overview

The advanced topics addressed in this section cover some of the most common deployment tasks that can be automated using the Scripting Toolkit.

IMPORTANT: The script files and script segments in this section are provided only as examples.

You must modify the scripts for your environment. When creating or modifying your own scripts, the pause command is a valuable tool to help you determine that each step of the script is functioning as desired.

Customizing deployment scripts using HPDISCOVERY and IFHW

Use the HPDISCOVERY utility to determine which devices and capabilities are available in a particular HP ProLiant server. HPDISCOVERY generates an XML-based output file that provides information such as system ROM version, amount of RAM available, and the types of devices present in the system. Then, use the HWQUERY and IFHW (IF Hardware utility) files to query the output file, enabling you to add conditional tests to a script so it performs different operations based on the outcome of the tests.

Querying the HPDISCOVERY file based on system name

In the following script, the IFHW utility searches the HPDISCOVERY data in the hpdiscovery.xml file for the system name HP ProLiant BL20p. If the system name is found, the script calls the

bl20p.cmd file.

ifhw .\hpdiscovery.xml allboards.xml HWQ:SystemName eq "ProLiant BL20p" if errorlevel 1 goto NEXT1 call .\BL20p.cmd goto end :NEXT1 ifhw .\hpdiscovery.xml allboards.xml HWQ:SystemName eq "ProLiant DL380 G4" if errorlevel 1 goto NEXT2 call .\ DL380G4.cmd goto end

Querying the HPDISCOVERY file to determine the presence of a particular card

Using IFHW to detect a particular PCI card or device can be valuable in determining which settings to apply. For example, an array controller used as a boot controller might require a RAID 1 setting, while an optional array controller used for a database (such as a Smart Array 5312 Controller) might require a RAID 5 ADG setting. The following example demonstrates how to use IFHW to detect a particular card or device:

REM *** Configure the array controllers by reading the configuration REM *** information in the script file and stamping it onto the array REM *** controllers of the target server echo Configuring the Array Controllers... ifhw .\hpdiscovery.xml allboards.xml PCI:"Smart Array 5i Controller" if errorlevel 1 GOTO NEXT1 .\SSA\bin\hpssascripting.exe -i .\ArraySettings\SA5iArray.ini :NEXT1 ifhw .\hpdiscovery.xml allboards.xml PCI:"Smart Array 6i Controller" if errorlevel 1 GOTO NEXT2

12 Advanced topics

.\SSA\bin\hpssascripting.exe -i .\ArraySettings\SA6iArray.ini :NEXT2 \ifhw .\hpdiscovery.xml allboards.xml PCI:"Smart Array 5312" if errorlevel 1 GOTO NEXT3 .\SSA\bin\hpssascripting.exe -i .\ArraySettings\SA5312Array.ini :NEXT3

Querying the HPDISCOVERY file to determine the presence of a card family

IFHW and HWQUERY can perform queries based on partial name information, enabling you to verify the presence of a whole family of cards by using a partial query such as Smart Array.

NEXT1: ifhw .\hpdiscovery.xml allboards.xml PCI:"Smart Array" if errorlevel 1 GOTO NEXT2 .\SSA\bin\hpssascripting.exe -i .\ArraySettings\GeneralArrayConfig.ini NEXT2:

Before creating a test condition, refer to the allboards.xml file to determine the correct name for the device or group of devices you want to query.

IMPORTANT: IFHW is case-sensitive. Incorrect case, misspellings, and incorrect spacing cause

the query to fail.

Booting Windows PE from a USB drive key

Some applications, such as the firmware update components, require the use of a writable medium. A writable file system allows for the expansion of the contents of the components and provides a scratch area for the backup firmware image copied from the device under flash. While using Windows PE on CD is not suitable for this purpose, a USB drive key provides the ideal medium for this type of activity.

NOTE: Booting from a USB drive key is supported only on certain HP ProLiant servers. For more

information, see the SPP website at http://www.hp.com/go/spp.

To boot Windows PE from a USB drive key, see the Microsoft Windows PE documentation.

Flashing the ROM in a Windows PE environment

You can run the Online ROM Flash Smart Components to flash system and option ROMs in the Windows PE environment, but you must ensure that a writable area is available for the component to use. You can use the Online ROM Flash Smart Components as part of a scripted installation before the operating system installation portion of the deployment.

Be sure to download the latest Online ROM Flash Smart Components for the system or option to be flashed. Be sure that the component number and the server name correspond. The latest ROM flash components are available from the HP software and drivers website at http://www.hp.com/

go/HPSC.

With flash system and option ROMs, you can create a script file to perform the following tasks:

• Use HPDISCOVERY and IFHW to determine the current system or option ROM.

• Run the Online ROM Flash Smart Component.

• Verify the error level.

The following script is provided as an example only and must be modified for your particular environment. Additional checks can be added as needed. Lines in bold type must be modified to customize the script.

System\hpdiscovery -f hpdiscovery.xml

Booting Windows PE from a USB drive key 13

System\ifhw hpdiscovery.xml System\allboards.xml HWQ:SystemName eq "ProLiant DL380 G2"

if errorlevel 1 goto NEXT1 REM ---REM This section performs the System ROM Flash. Online Flash components REM are kept in a directory called Roms REM ----

Roms\cp004648.exe /INSTPATH:S:\ROMScratcharea

REM ---REM Check the error code returned to determine Success or Failure REM ---if errorlevel 3 goto HWNOTFOUND if errorlevel 2 goto REBOOTREQUIRED if errorlevel 1 goto NEXT2 goto end NEXT1: REM Try next system type

System\ifhw hpdiscovery.xml System\allboards.xml HWQ:SystemName eq "ProLiant DL380 G3"

if errorlevel 1 goto NEXT2 REM ---REM This section performs the System ROM Flash. Online Flash components REM are kept in a directory called Roms REM ----

Roms\cp005041.exe /INSTPATH:S:\ROMScratcharea

System\ifhw hpdiscovery.xml System\allboards.xml PCI:"Smart Array 5i Controller"

if errorlevel 1 goto NEXT3 REM ---REM This section performs the Option ROM Flash. Online Flash components REM are kept in a directory called Roms REM ----

Roms\cp002238.exe /INSTPATH:S:\ROMScratcharea

REM ---REM Check the error code returned to determine Success or Failure REM ---if errorlevel 3 goto HWNOTFOUND if errorlevel 2 goto REBOOTREQUIRED if errorlevel 1 goto NEXT3 goto end

14 Advanced topics

NEXT3: REM ---REM DONE REM ---REBOOTREQUIRED: System\reboot PXE HWNOTFOUND: End:

Erasing array configurations

Before beginning the deployment process, you might want to erase the current array configuration. The commands in the following examples can be run as part of a script or alone.

To erase the array configuration:

1. Use the Microsoft DiskPart utility to clear the partition table: a. Create a script file called ErasePart.txt that contains the following commands:

REM This file instructs Diskpart.exe to select the first disk as REM target, then clean the target. rescan select disk=0 clean

b. Run the Microsoft DiskPart utility to clear the partition table:

diskpart /s .\ErasePart.txt

2. Use HP SSA to erase the array configurations:

hpssascripting -i erase.ini

The erase.ini file is provided in the Scripting Toolkit sample files.

Erasing array configurations 15

4 Scripting Toolkit utilities

Syntax conventions

Syntax refers to the way a command and parameters must be entered. Unless specified otherwise, enter commands, parameters, and switches in all uppercase or all lowercase letters.

Sample syntax line:

SAMPLE[/R|-R][DRIVE:][PATH]FILENAME[...]

MeaningCommand element

SAMPLE

[ ]

/ or -

DRIVE:

PATH

FILENAME

...

Specifies the name of the command.

Indicates a component of the command line. Enter only the information within the brackets, not the brackets themselves.

Indicates a command line switch for executable files.

Specifies the name of the hard disk drive, diskette drive, or other storage device.

Specifies the route the operating system must follow through the directory structure to locate a directory or file. A path and file name must be specified only if the file is not in the current directory.

This document uses uppercase file names. A device name or a drive letter cannot be specified for a file name.

Indicates that the previous parameter or switch can be repeated several times in a command. Enter only the information, not the ellipsis (…) itself.

In this document, the length of an example command or syntax might require it to continue on another line. When this happens, the second line and any additional lines are indented under the first line.

Placeholder items used in the syntax lines in this chapter include:

• Source—Specifies the location of the data to be transferred to a specified destination or used

as input to a command. The source can consist of a drive letter and colon, a directory name, a file name, or a combination of these items.

• Destination—Specifies the location to which the data specified by the source is to be transferred.

The destination can consist of a drive letter and colon, a directory name, a file name, or a combination of these items.

• String—Specifies a group of characters to be treated as a unit. A string can include letters,

numbers, spaces, or any other characters and is usually enclosed in double quotation marks.

Utility online help

Most Scripting Toolkit utilities include usage instructions. To obtain help with the syntax, parameters, and switches of a particular Scripting Toolkit utility, enter the file name followed by -h in the command line. For example, for usage instructions on the CONREP utility, enter the following command:

CONREP -h

The utility displays information about its command line syntax, argument, and switches.

Using Scripting Toolkit utilities

The Scripting Toolkit utilities control the installation process, read the source server configuration, and duplicate the configuration on a target server through a generated script file.

16 Scripting Toolkit utilities

The Scripting Toolkit utilities include:

• REBOOT

• SETBOOTORDER (Limited functionality for HP ProLiant 100 series servers)

• STATEMGR (Utility is not supported on 100 series servers)

• RBSURESET

• HPDISCOVERY

• IFHW

• HWQUERY

• CONREP

• HPRCU

• HPSSASCRIPTING

• HPLPCFG

• LO100CFG (Utility only supports HP ProLiant 100 series servers)

• HPQLAREP

• HPONCFG (Not supported on HP ProLiant 100 series servers using the Oxx ROM family)

Using REBOOT

The REBOOT utility enables the user to reboot the server, controlling which device is the boot device. In conjunction with other utilities, the REBOOT utility controls server reboots from a batch file.

REBOOT command-line syntax

REBOOT [DRIVE:] [-h]

REBOOT command-line arguments

DescriptionCommand line argument

[DRIVE:]

—c

—h

Valid arguments that can be passed to REBOOT are A:, C:, CD, RBSU, or PXE. By specifying an argument, the drive indicated is set to boot on the next reboot, and the system is restarted. If no argument is provided, then the system is set to boot using the defined boot order.

This argument performs a one-time cold boot of the system.

This argument displays help information.

REBOOT return codes

MeaningValue

Success

Incorrect command line

Using REBOOT 17

REBOOT command-line examples

DescriptionCommand-line argument

REBOOT A:

REBOOT PXE

This command reboots the system to the A: drive.

This command reboots the system by itself to the PXE NIC.

Using SETBOOTORDER

SETBOOTORDER enables you to set the order in which devices are booted, including CD-ROM or DVD drives, hard drives, PXE, and USB devices. This utility sets the boot order only for devices that exist for a server. The devices can be set to boot in any order.

SETBOOTORDER cannot be used to set the storage controller order. You must use the CONREP utility. For more information about setting the controller order, see “Using CONREP” (page 24)

NOTE: Any changes made to the SETBOOTORDER take affect at the next reboot. For HP ProLiant

servers with Oxx ROM Family (most 100 series servers), only one device can be set as the boot device and others cannot be re-ordered. These Oxx servers do not support the default or usb parameters.

SETBOOTORDER command-line syntax

setbootorder [floppy cdrom pxe hd usb | default] [-h]

SETBOOTORDER command-line arguments

Options are disabled if not listed in the argument.

NOTE: UEFI-based servers no longer support floppy as a boot option in any mode, including

Legacy.

floppy cdrom pxe hd usb

default

—h

SETBOOTORDER return codes

SETBOOTORDER command-line examples

DescriptionCommand line argument

The order of these arguments sets the boot order for the system devices. Each term can be used only once in any order. It is not necessary to use all terms. HP ProLiant 100 series servers can only pass in one option.

This argument resets the boot order to the factory default.

This argument displays help information.

MeaningValue

The boot order was set successfully.

Incorrect command line..

SETBOOTORDER cdrom hd pxe usb

SETBOOTORDER default

18 Scripting Toolkit utilities

DescriptionCommand-line argument

This command sets the system devices to boot in this order: CD-ROM drive, hard drive, PXE, USB.

This command sets the boot order to the factory default.

Using STATEMGR

The STATEMGR utility enables the user to keep track of the execution state during system reboots. This utility saves persistent state information across reboots of the system.

NOTE: The STATEMGR utility is not supported on 100 series servers.

STATEMGR command-line syntax

STATEMGR [-R] [EVNAME] [-h]

- or -

STATEMGR [-W] [EVNAME] [VALUE] [-h]

STATEMGR command-line arguments

DescriptionCommand-line argument

–R

-W

EVNAME

VALUE

—h

STATEMGR return codes

This argument reads the state of the environment variable defined by [EVNAME]. The value of the environment variable is returned as a return code.

This argument writes the state defined by [VALUE] to an environment variable defined by [EVNAME].

This argument creates an environment variable used to represent the state to manage. The variable can be any word that is eight characters or fewer.

This argument is used only with the -W argument to indicate the value of the environment variable to maintain. [VALUE] is limited to integers between 0 and 254. If no value is provided when using -W, the state environment variable is cleared.

This argument displays help information.

MeaningValue

The command was completed successfully.

N arguments were ignored because they were not in the variable=<string> format.

STATEMGR command-line examples

STATEMGR —W PHASE 3

STATEMGR —R PHASE

Using RBSURESET

RBSURESET resets the BIOS settings for a server by reapplying the default factory setting at the next reboot. To prevent accidental or malicious damage to a server's configuration, this utility only functions in a Windows PE environment. It will not operate in any other Windows environment.

DescriptionCommand-line argument

STATEMGR writes the state value 3 to the PHASE environment variable.

STATEMGR reads the PHASE environment variable and returns its value as a return code. If the environment variable has been reset or no value has been stored, the return code is 0.

Using STATEMGR 19

RBSURESET does not erase array configurations or logical storage volumes.

RBSURESET command-line syntax

rbsureset [-h]

RBSURESET command-line arguments

DescriptionCommand-line argument

[-h]

RBSURESET return codes

Using HPDISCOVERY

HPDISCOVERY provides an inventory of the server being configured and must run on each deployed server. HPDISCOVERY is executed by the server configuration script and captures the following information:

• System ID (This field is not supported on 100 series servers)

• System name

• ROM information

• Processor information

• NIC information

This argument displays help information.

MeaningValue

The BIOS settings have been successfully reset.

Incorrect command line.

• PCI devices present in the system

• HP Smart Array controller information

User process decisions can be made based on data that is in the file created by this utility. The HPDISCOVERY program loads all plug-ins listed in the DAT file. If no plug-ins were passed on

the command line and the DAT file does not exist, then the program searches the current directory for the plug-ins and loads them.

NOTE: Information may not be as detailed on HP ProLiant 100 series servers.

HPDISCOVERY command-line syntax

hpdiscovery —f —c [drive:][path]filename [-h]

HPDISCOVERY command line arguments

[drive:][path]filename

DescriptionCommand-line argument

This argument specifies the location and name of the HPDISCOVERY data file. If no file name is specified, the utility generates a file in the current directory using the default name hpdiscovery.xml.

This argument displays help information.–h

20 Scripting Toolkit utilities

DescriptionCommand-line argument

–c

–f

HPDISCOVERY return codes

This argument chooses the name and location of the configuration file. If the user does not pass in this parameter, then the default filename will be hpdisc_plugins.dat, and it will be saved in the current directory.

This argument chooses the name and location of the output file. If the user does not pass in this parameter, then the default filename will be hpdiscovery.xml, and it will be saved in the current directory.

MeaningValue

The command was completed successfully. A usage message might appear.

Invalid command line.

Missing plug-in file.

Failure to save XML file.

Failure to load plug-in.

HPDISCOVERY command line examples

NOTE: Before running HPDISCOVERY, you must install WMI. For more information on installing

extra packages in Windows PE, see the Windows PE documentation.

hpdiscovery /f x:\hpdiscovery.xml

hpdiscovery /p plugin storage.dll

hpdiscovery

Using IFHW

IFHW is used from a script file, in conjunction with other utilities, to control the deployment. The IFHW utility enables you to make intelligent queries against the hardware discovery file. Queries take the form of a logical expression, and the result of the expression is returned as the return code of the tool, which the hosting script can use to conditionally perform actions.

IFHW command-line syntax

ifhw [drive:][path]hpdiscoveryfilename [drive:][path]allboards.xml <expression>

DescriptionCommand line argument

This command generates the hpdiscovery.xml file in the x:\ location.

This command only loads and executes the storage plug-in.

This command generates the hpdiscovery.xml file in the current directory.

Using IFHW 21

IFHW command-line arguments

DescriptionCommand-line argument

[drive:][path]hpdiscoveryfilename

[drive:][path]allboards.xml

IFHW return codes

MeaningValue

The expression is true.

The expression is false.

The expression was not understood or an argument was invalid.

IFHW command line examples

ifhw hpdiscovery.xml allboards.xml "PCI:Smart Array 5i"

This argument specifies the hardware discovery file used to run the query.

This argument specifies the allboards.xml PCI device list file, which is used to convert PCI IDs found in hardware discovery into device names, such as "Smart Array 5i Controller."

This argument specifies the query expression. See "Expression operators and terms (page 22)."

DescriptionCommand-line argument

This command returns the following error levels:

• ERRORLEVEL 0 (True) if the Smart Array 5i is present

• ERRORLEVEL 1 (False) if the device is not present

• ERRORLEVEL 2 (Error) if the expression could not be

understood

Expression operators and terms

ResultOperator or term

and

gte

lte

neq

not

PCI:<string>

True if both operands are true

True if either operand is true

True if the first operand is greater than the second

True if the first operand is less than the second

True if the first operand is greater than or equal to the second

True if the first operand is less than or equal to the second

True if the two operands are equal

True if the two operands are not equal

True if the operand is false

True if a PCI device whose name includes <string> is found in the hardware discovery file. <string> is case-sensitive.

22 Scripting Toolkit utilities

ResultOperator or term

HWQ:<string>

Expression examples

"PCI:Smart Array 5i"

HWQ:TotalRAM gte 512

HWQ:ROMDate neq

"11/12/2004"

HWQ:SystemName eq

"ProLiant DL380 G2"

HWQ:SystemName eq

"ProLiant DL380 G2" and "PCI:Smart Array 5i" and HWQ:ROMDate eq "11/12/2004"

The hardware discovery file is searched for <string>, and the corresponding value is the value of this term. <string> is case-sensitive.

A literal string, used for comparison<string>

A literal number, used for comparison<number>

ResultExpression input

True if the Smart Array 5i Controller is found in the system

True if the amount of RAM in the hardware discovery file is at least 512 MB

True if the ROM date in the hardware discovery file is not 11/12/2004

True if the system name in the hardware discovery file exactly matches "ProLiant DL380 G2"

True if the system is a ProLiant DL380 G2 with a Smart Array 5i Controller present and a ROM date of 11/12/2004

"PCI:Smart Array 5i" or "PCI:Smart Array 6i"

Using HWQUERY

HWQUERY is used from a script, in conjunction with other utilities, to control the deployment. The HWQUERY utility enables you to use data from the hardware discovery file in your own scripts. HWQUERY cannot alter environment variables directly. To set the variable, the output of HWQUERY must be used by the hosting script. The most common way to use it is to write the output to an intermediate script that is subsequently called by the hosting script.

HWQUERY command-line syntax

hwquery [drive:][path]hpdiscoveryfilename [drive:][path]allboards.xml variable=<string> ...

HWQUERY command line arguments

[drive:][path]hpdiscoveryfilename

[drive:][path]allboards.xml

True if the system contains a Smart Array 5i Controller or a Smart Array 6i Controller

DescriptionCommand-line argument

This argument specifies the hardware discovery file used to run the query.

This argument specifies the allboards.xml PCI device list file, which is used to convert PCI IDs found in hardware discovery into device names, such as "Smart Array 5i Controller."

variable=<string>

...

In this argument, variable is the name of an environment variable and <string> is a PCI device name or the name of an element from the hardware discovery file. Arguments must be in quotes if <string> contains spaces. <string> is case-sensitive.

You can specify multiple variable=<string> arguments.

Using HWQUERY 23

HWQUERY return codes

MeaningValue

HWQUERY command-line examples

hwquery hpdiscovery.xml allboards.xml MY_SYS_RAM=TotalRAM

hwquery hpdiscovery.xml allboards.xml "TEST=Smart Array"

hwquery hpdiscovery.xml allboards.xml MYRAM=TotalRAM MYROMDATE=ROMDate

The command was completed successfully.

N arguments were ignored because they were not in the variable=<string> format.

DescriptionCommand-line argument

For a hpdiscovery.xml file that contains <TotalRAM>768</TotalRAM>, HWQUERY produces the following:

MY_SYS_RAM=768

For a hpdiscovery.xml file that indicates a Smart Array 5i Controller is present, HWQUERY produces the following:

TEST=Smart Array 5i Controller

For a hpdiscovery.xml file that contains <TotalRAM>768</TotalRAM> and <ROMDate>11/15/2002</ROMDate>, HWQUERY produces the following:

MYRAM=768

MYROMDATE=11/15/2002

hwquery hpdiscovery.xml allboards.xml "TEST=smart array 5i"

Using CONREP

The CONREP utility generates a system configuration XML file used to duplicate the hardware configuration of one HP ProLiant server onto another. The CONREP utility uses the hardware configuration XML file to identify and configure the system, which defaults to conrep.xml. You can change the default using the -x option. The actual system configuration file is captured as an XML data file. The default name is conrep.dat.

CAUTION: Improper modification of the CONREP data files can result in the loss of critical data.

Only experienced users of the Scripting Toolkit should attempt to modify the data files. Because of the potential risk of data loss, take all necessary precautions to ensure that mission-critical systems remain online if a failure occurs.

The CONREP utility reads the state of the system environment settings to determine the server configuration and writes the results to a file that you can edit. The CONREP utility uses the data in the generated file to configure the target server hardware.

The CONREP utility uses an XML definition file to determine what information to retrieve from and restore to the server. You can modify this file to update new features or restrict features when capturing configurations. The default conrep.xml file contains common hardware configuration settings for most HP ProLiant series servers other than HP ProLiant 100 series servers using the Oxx ROM family. Some platforms require special settings that are contained in other XML files. These files are included in the Scripting Toolkit and are available from the HP website at http://

Although the controller is present, HWQUERY produces the following:

TEST=

This behavior is correct. The string is case-sensitive, and the argument uses lowercase lettering instead of the uppercase found in the allboards.xml file.

24 Scripting Toolkit utilities

www.hp.com on the support page for each platform. You can use these files with the -x option to

configure systems that are not supported by the default hardware configuration file. Many fields in the conrep.xml file contain help text that enables you to configure the field

meanings. This information is also added to the conrep.dat file. Hardware features that are not supported by the existing platform or ROM version appear in the conrep.dat file.

IMPORTANT: The file format for the DOS version of CONREP and the current version of CONREP

are not compatible.

NOTE: Asset Tag Protection - Lock/Unlock cannot be read or changed on the HP ProLiant DL580

Gen8 server using CONREP. To change this feature, use the UEFI System Utilities. For more information, see the HP

UEFI System Utilities User Guide

CONREP command-line syntax

conrep [-s | -l] [-x hardware_definition_file] [-f system_configuration_file] [-h]

CONREP command-line arguments

DescriptionCommand-line argument

-s

-l

-x filename

-f filename

-h

CONREP return codes

This argument saves the system configuration to a file.

This argument loads the system configuration from a file and writes it to the target server.

This argument defines the name and location of the XML hardware definition file. The default file is conrep.xml.

This argument defines the name and location of the system configuration data file. The default file is conrep.dat.

This argument displays help information.

MeaningValue

The command was completed successfully.

The hardware definition data file (conrep.xml) is corrupt or not found.

The system configuration data file (conrep.dat) is corrupt or not found.

The Health Driver is required for this operation but is not loaded.

255

The system administrator password is set. The settings cannot be changed unless this password is cleared.

The XML hardware definition file (conrep.xml) is corrupt or not appropriate for the current platform.

No XML tag.

Invalid command line or usage error.

General error. See error message for details.

Using CONREP 25

CONREP screen output

A typical screen output generated by CONREP is similar to the following:

conrep 3.00 - Scripting Toolkit Configuration Replication Program Copyright (c) 2007-2012 Hewlett-Packard Development Company, L.P. System Type: ProLiant DL360 G4 ROM Date: 08/16/2005 ROM Family: P52 XML System Configuration: conrep.xml Hardware Configuration: demo.dat File contains global platform restrictions Global Restriction: [minimumconrepversion] OK Platform check: [ProLiant DL3] match [ProLiant DL5] no match Saving configuration data to demo.dat. CONREP Return code: 0

CONREP -s (Store to Data file)

This is an example of usage for HP ProLiant servers not using the Oxx ROM family. To extract the BIOS settings from an SL160z G6 server and save the configuration to an "sl160zconrep.dat" data file:

[root@ilo002481b08134 conrep]# ./conrep -s -xconrepSL160zg6_20090728.xml -fsl160zconrep.dat

conrep 3.00 - Scripting Toolkit Configuration Replication Program Copyright (c) 2007-2012 Hewlett-Packard Development Company, L.P. System Type: ProLiant SL160z G6 ROM Date : 07/28/2009 ROM Family : O33 Processor Manufacturer : Intel XML System Configuration : conrep_SL160zg6_20090728.xml Hardware Configuration : sl160zconrep.dat Saving configuration data to sl160zconrep.dat. CONREP Return code: 0

NOTE: The file names after the -x and -f options must be specified, otherwise, the default file

names conrep.xml and conrep.dat are used, respectively.

NOTE: A platform specific XML file needs to be used for HP ProLiant 100-series servers. If you

use the default name this may cause an error while running the CONREP utility.

CONREP –l (Load from Data File)

This is an example of usage for HP ProLiant servers not using the Oxx ROM family. To load the BIOS configuration settings from a previously captured/edited data file (in this case “sl160zconrep.dat”) to an SL160z G6 server:

[root@ilo002481b08134 conrep]# ./conrep -l -xconrepSL160zg6_20090728.xml -fsl160zconrep.dat

26 Scripting Toolkit utilities

Processor Manufacturer : Intel XML System Configuration : conrep_SL160zg6_20090728.xml Hardware Configuration : sl160zconrep.dat Loading configuration from sl160zconrep.dat. ASM values not set! aborting CONREP Return code: 0

CONREP Data File Sample Contents for HP ProLiant servers not using the Oxx ROM family

A typical data file generated by CONREP is similar to the following:

<Conrep_data> <Section name="Controller_Order"> <Id0>0e 11 40 80 </Id0> <Slot0>00 </Slot0> <BusDev0>00 08 </BusDev0> <Rest0>01 </Rest0> <Id1>0e 11 ff ff </Id1> <Slot1>00 </Slot1> <BusDev1>00 78 </BusDev1> <Rest1>c1 </Rest1> </Section> <Section name="Language">ENGUSAus </Section> <Section name="System_WOL">Disabled</Section> <Section name="System_APIC">Auto Set</Section> <Section name="System_COMA">COM1</Section> <Section name="System_COMA_IRQ">IRQ4</Section> <Section name="System_COMB">Disabled</Section> <Section name="System_COMB_IRQ">Undefined</Section> <Section name="System_LPT">LPT1</Section> <Section name="System_LPT_IRQ">IRQ7</Section> <Section name="Diskette_Write_Control">Writes_Enabled</Section> <Section name="NMI_Debug_Button">Disabled</Section> <Section name="ACPI_Power_Button">Disabled</Section> <Section name="ASR">Disabled</Section> <Section name="ASR_Timeout">10 Minutes</Section> <Section name="Thermal_Shutdown">Enabled</Section> <Section name="RBSU_Language">01</Section> <Section name="PXE_NIC1">Disabled</Section> <Section name="PXE_NIC2">Disabled</Section> <Section name="BIOS_Console">Disabled</Section> <Section name="EMS_Console">Disabled</Section> <Section name="Diskette_Boot">Enabled</Section> <Section name="NumLock">On</Section> <Section name="POST_Speed_Up">Enabled</Section> <Section name="Integrated_Diskette_Controller">Enabled</Section> <Section name="PCI_Bus_Reset">Enabled</Section> <Section name="Hot_Plug_Reservation">Auto Set</Section> <Section name="Memory_Protection">Standard ECC Protection</Section>

Using CONREP 27

</Conrep_data>

CONREP command file contents

A typical data file generated by the CONREP command is similar to the following:

<?xml version="1.0" encoding="UTF-8"?>  <Conrep version="3.00" originating_platform= "ProLiant DL360 G4" originating_family= "P52" originating_romdate= "08/16/2005"> <Section name="IPL_Order" helptext= "Current Initial Program Load device boot order"> <Index0>00 </Index0> <Index1>01 </Index1> <Index2>03 </Index2> <Index3>02 </Index3> <Index4>04 </Index4> <Index5>ff </Index5> <Index6>ff </Index6> <Index7>ff </Index7> </Section> <Section name="PCI_Devices" helptext=

"Lists of PCI devices and their interrupts-not displayed if default" >EMPTY_DELETE</Section>

Using HPRCU

HPRCU is an RBSU configuration utility similar to CONREP. This utility is supported on all HP ProLiant Gen8 servers except the HP ProLiant DL580 Gen8 server. This utility does not use a definition XML file like the CONREP utility, but directly reads the same table that RBSU uses for feature names and settings. All features and options are number based. Each feature and option has a unique number.

28 Scripting Toolkit utilities

Using HPRCU has the following features:

• All system ROM settings and the current selections are listed together in one output/input XML

file.

• No updated binary or XML file is needed when BIOS adds or changes features. HPRCU now

reads the same tables that RBSU does, which are located in the memory at system boot. When the BIOS changes or adds a new setting, no update to HPRCU is needed.

• The HPRCU XML file shows the default settings for each RBSU option.

HPRCU is not supported on UEFI-based ProLiant servers. Instead, use CONREP.

HPRCU command-line syntax

hprcu -s | -l | —r [-f file.xml ] [ -h ]

HPRCU command line arguments

DescriptionCommand line argument

-s

-l

-f {file.xml}

-h

-t

-r

HPRCU return codes

This argument saves the system configuration to a file.

This argument loads the system configuration from a file and writes it to the target server.

Name of the input or output file. If not specified, the XML configuration defaults to hprcu.xml.

This argument displays program usage.

Outputs the help and warning text for each feature. Only valid with the -s option.

Saves or loads raw data features, such as IPL, PCI devices, controller order) Must be applied to identical systems.

DescriptionCommand line argument

The command was completed successfully.0

The server is not supported by this utility.1

The input XML file is missing or is in an invalid format.2

One of the dependencies is missing. See the error message for details.

HPRCU sample XML format

A sample XML format generated by HPRCU is similar to the following:

<hprcu>

The system RBSU password is set. The settings cannot be changed until the password is cleared from within RBSU.

An error occurred reading the supported features on the server.

Invalid command line syntax. Use the -h parameter for complete command line parameters.

A general error occurred saving or loading the server settings. See the error message for details.

Using HPRCU 29

<informational> <product name>ProLiant DL380 Gen8</product_name> <system_rom_family>P64</ system_rom_family > <system_rom_date>11/01/2011</system_rom_date> </informational>

<feature_name>Intel(R) Hyperthreading Options</feature_name> <option option_id='1'><option_name>Enabled</option_name></option> <option option_id='2'><option_name>Disabled</option_name></option> </feature> <feature feature_id='100' feature_type=’string’> <feature_name>Server Name - Line 1</feature_name> <feature_value>SERVERNAME</feature_value> </feature> </hprcu>

Using HPSSASCRIPTING

Starting with version 8.28.13.0, HP SSA Scripting is now a standalone application that is distributed with the HP SSA CLI application. In HP SSA versions prior to 8.28.13.0, the scripting executable was provided with the HP SSA GUI component.

For more information, see the Configuring Arrays on HP Smart Array Controllers Reference Guide on the HP website at http://www.hp.com/support/CASAC_RG_en.

Users familiar with the previous versions of HP SSA Scripting must now install the HP SSA CLI application to obtain the scripting executable. The new HP SSA scripting executable (hpssascripting) replaces the former executable (cpqssaxe) in all scripts.

The HP SSA Scripting application has two scripting modes:

• Capture mode for capturing a configuration (page 30)

HP SSA inspects the configuration of all internal and external array controllers connected to the server and then writes a script file describing this configuration.

• Input mode for using an Input script (page 31)

HP SSA reads the array configuration described in a specified script file. See “Creating an HP

SSA script file” (page 31). HP SSA then applies this configuration to a target system.

NOTE: For a complete list of all command-line parameters, execute the /h utility.

Capturing a configuration

To capture the configuration of a system, enter the following command at the system command line prompt:

hpssascripting -c [drive:][path] OUTPUTFILENAME.ext [-internal |

-external] -e [drive:][path]ERRORFILENAME.ext

OUTPUTFILENAME is the name of the capture file, and ext. is the file extension. If you do not specify a name and location for this file, HP SSA uses the default name HPSSAOUTPUT.ini and places the file in the HP SSA working directory.

The -internal and -external switches limit capture to internal or external controllers. The -e switch information is used only if HP SSA must generate an error file. By default, HP SSA

names the error file ERROR.ini and places it in the HP SSA working directory.

30 Scripting Toolkit utilities

Using an Input script

To use an Input script to configure or reconfigure a system, first locate a suitable HP SSA script or see “Creating an HP SSA script file” (page 31).

Then, enter the following command at the system command line prompt:

hpssascripting -i [drive:][path]FILENAME.ext [-internal | -external] [-reset] -e [drive:][path]ERRORFILENAME.ext

FILENAME is the name of the HP SSA input file, and ext is the file extension. If you do not specify the name and location of this file, HP SSA searches for HPSSAINPUT.ini in the HP SSA working directory.

The -internal and -external switches limit configuration operations to internal or external controllers.

The -reset flag destroys any existing data and overwrites the current configuration with the configuration specified in the script.

The -e switch information is used only if HP SSA must generate an error file. By default, HP SSA names the error file ERROR.ini and places it in the HP SSA working directory.

Creating an HP SSA script file

To create a valid HP SSA script file, use one of the following methods:

• Modify the sample custom input script (page 31).

• Create a Capture file for capturing a configuration (page 30).

You can create a capture file from any server that has HP SSA loaded, and then modify the values of options in the file as necessary for the target system. This method is useful for applying a standard configuration to several servers that have similar storage resources.

• Write an original script.

Each line of text in an HP SSA script file is in the format option = value and can be written in uppercase or lowercase letters. For information about possible option values and the minimum configuration information that a valid script must have, see “Sample custom input

script” (page 31).

You can add blank lines and comments to any script to make it easier to read and understand. To create a comment, enter a semicolon, and then enter the comment text. HP SSA ignores all text on the same line after a semicolon.

Sample custom input script

The sample script in this section gives all possible values for each option.

• If an option is shown in bold type, you must enter a value for that option when writing your

own script.

• If a value is shown in bold type, HP SSA uses that value as a default setting when creating

new logical drives.

You can use this script as a template for your own script. The Control category has the following options:

• Action mode

• Method mode

Action = Configure|Reconfigure Method = Custom|Auto ; COMMENT: HP SSA cannot create a RAID 50 or

RAID 60 configuration in Auto mode. You must create such configurations manually using the Custom setting.

Using HPSSASCRIPTING 31

ClearConfigurationWithDataLoss = Yes|No ; COMMENT: This option is now deprecated.

LicenseKey = XXXXX-XXXXX-XXXXX-XXXXX-XXXXX

DeleteLicenseKey = XXXXX-XXXXX-XXXXX-XXXXX-XXXXX | * ; COMMENT: * is a wild card that enables you to delete all license keys on the specified controller.

RAIDArrayID = “XXXXXXXXXXXXXXXXXXXX”

ReadCache = 0|10|20|25|30|40|50|60|70|75|80|90|100

WriteCache = 0|10|20|25|30|40|50|60|70|75|80|90|100 RebuildPriority = Low|Medium|High ExpandPriority = Low|Medium|High

SurfaceScanDelay = N

SSPState = Enable|Disable PreferredPathMode = Auto|Manual

; COMMENT: the following five entries are used to optimize the controller performance for video

MNPDelay = 0|1|2|...|60 ; units are minutes, zero indicates disabled

IRPEnable = Yes|No

DPOEnable = Yes|No

ElevatorSortEnable = Yes|No

QueueDepth = 2|4|8|16|32|Auto

Array = A|B|C|D|E|F|G|...Z|a|b|c|d|e|f

Drive = * | N | Port:ID,Port:ID... | Box:Bay,Box:Bay... | Port:Box:Bay,Port:Box:Bay,...

DriveType = SCSI | SAS | SATA

LogicalDrive = 1|2|3|...32

RAID = 0|1|5|50|6|60|adg|auto ; COMMENT: RAID 6 and 60 are only available when SAAP is installed and the license key registered

ParityGroups = 2|N ; COMMENT: Necessary only for RAID 50 or 60. N > 2

Size = [N]|Max

Sectors = 32|63

StripeSize = 8|16|32|64|128|256

ArrayAccelerator = Enable|Disable

LogicalDriveSSPState = Enable|Disable

SSPAdaptersWithAccess = [N],[N]...|None

PreferredPath = 1|2

HBA_WW_ID = WWN

32 Scripting Toolkit utilities

ConnectionName = UserDefinedName

Script file options

Options in HP SSA script files are divided into the following categories:

• “Control category” (page 34)

• “Controller category” (page 34)

• “Array category” (page 37)

• “Logical Drive category” (page 38)

• “HBA category” (page 41)

Each category has several scripting options, but you do not always need to assign values to every option. HP SSA can use default values in some instances, while in other instances, a listed option might not be relevant for a particular configuration or scripting mode.

The options for each category are listed in the following table and described in more detail in the remainder of this section.

DescriptionOptionsCategory

Control

Controller

Action Method

Controller ChassisName ClearConfigurationWithDataLoss DeleteLicenseKey DPOEnable ElevatorSortEnable ExpandPriority IRPEnable LicenseKey MNPDelay PreferredPathMode QueueDepth ReadCache RebuildPriority SSPState SurfaceScanDelay WriteCache

Use these options to define the overall behavior of HP SSA when it processes scripts and creates configurations. Control options can occur only once in a script file and must be listed first.

Use these options to specify the controller you are configuring (or the controller that had its configuration captured). Although the Controller option must begin this section of the script, you can script other options in this category in any order.

You can use one script file to configure all controllers in a system, and you can configure the controllers identically or individually. If you define each controller configuration individually, enter the option values for one controller and its arrays and logical drives before specifying the option values for another controller.

Array

Logical Drive

Array Drive DriveType OnlineSpare

ArrayAccelerator LogicalDrive LogicalDriveSSPState

Use these options to describe an array you are configuring on the controller previously specified in the script. (If no controller was previously specified, HP SSA stops processing the script and creates an error file.) Although the Array option must begin this section of the script, you can script the other options in this category in any order.

Use these options to describe a logical drive you are configuring on an array previously specified in the script. (If no array was previously specified, HP SSA stops processing the script and creates an error file.)

Using HPSSASCRIPTING 33

DescriptionOptionsCategory

Control category

The Control category has the following options:

• “Action mode” (page 34)

• “Method mode” (page 34)

Action mode

You must specify an Action mode:

• In Configure mode, you can create new arrays, but you cannot modify existing arrays. The

controller must be connected to unassigned physical drives for this mode to be available.

ParityGroups PreferredPath RAID Sectors Size SSPAdaptersWithAccess StripeSize

HBA_WW_ID HostMode

Although the LogicalDrive option must begin this section of the script, you can script the other options in this category in any order.

Use these options to specify an HBA you are configuring.ConnectionNameHBA

• In Reconfigure mode, you can modify existing arrays. For example, you can set up an array

expansion, a logical drive extension, or a migration. These procedures do not destroy data, unless you specifically want the data to be deleted. In this mode, HP SSA does not change an existing option setting unless you specifically script a different value for that option.

Method mode

The default value for Method mode is Auto. If you want to use Custom mode, you must specify it. In Auto mode, HP SSA can perform an expansion, extension, or migration without user intervention

if the values that you set for other options imply that such an operation is necessary.

Controller category

The Controller category has the following options:

• Controller (page 35)

• ChassisName (page 35)

• ClearConfigurationWithDataLoss (page 35)

• DeleteLicenseKey (page 35)

• DPOEnable (page 37)

• ElevatorSortEnable (page 37)

• ExpandPriority (page 36)

• IRPEnable (page 37)

• LicenseKey (page 35)

• MNPDelay (page 37)

• PreferredPathMode (page 35)

34 Scripting Toolkit utilities

• QueueDepth (page 37)

• ReadCache (page 36)

• RebuildPriority (page 36)

• SSPState (page 36)

• SurfaceScanDelay (page 37)

• WriteCache (page 36)

Controller

You must enter a value for this option because it identifies the controller that you want to configure:

• All—Configure all detected controllers in the system.

• Slot [N][:M]—Configure the internal controller in slot number N, or the external controller

at port M in slot N.

• WWN [N]—Configure the external controller that has the World Wide Name N.

• SerialNumber [N]—Configure the shared storage controller that has serial number N.

• IOCabinet[N],IOBay[N],IOChassis[N],Slot[N],Cabinet[N],Cell[N]—Configure

the controller in the Integrity server that has the slot path information defined by this sequence of identifiers.

ChassisName

Enter the user-defined character string that identifies the controller. You can use any of the following characters in the string:

a–z, A–Z, 0–9, !, @, #, *, (, ), ,, -, _, +, :, ., /, [space] You do not need to use quotation marks around the string, but doing so allows the string to begin

with a space character. However, the string cannot end with a space character. Currently, only shared-storage controllers such as the RA4x00, MSA1000, and Smart Array Cluster

Storage support the ChassisName option. The RA4x00 controller uses a 24-character string, while other applicable controllers use a 20-character string.

ClearConfigurationWithDataLoss

This command is now deprecated. The default value for this option is No. Clearing the configuration causes data loss because it

deletes all logical volumes and arrays on the controller. If you clear a configuration, you can write commands later in the script file to create a new configuration from the liberated drive capacity.

LicenseKey, DeleteLicenseKey

These options enable you to enter a 25-character license key to activate or uninstall some controller features. Hyphens can be entered, but are not required.

PreferredPathMode

The setting that you select for this option determines how the preferred I/O path to a particular logical drive is set for a redundant array controller that is in an active/active configuration.

Using HPSSASCRIPTING 35

Not all controllers support this feature, and controllers in an active/standby configuration disregard this option.

• Auto is the default setting for new configurations. In this case, the storage system automatically

selects the I/O path from the redundant controller to the logical drive and dynamically load balances all paths.

• Manual enables you to assign the logical drive to a specific redundant controller. If you select

this setting, use the PreferredPath command to specify the path.

If you are reconfiguring a controller and do not specify a setting for this option, the existing setting remains the same.

ReadCache, WriteCache

Enter a number between 0 and 100 to specify the percentage of cache to be allocated to drive reads or writes. The default value for both options is 50.

The allowable cache ratios depend on the controller model and whether it has battery-backed write cache, as described in the following table.

A "+" indicates that the specified cache ratio is allowed for that type of controller, while a "–" indicates that the ratio is not allowed.

Read:write ratio

RA4x00 with 16MB cache

RA4x00 with 48MB cache

All other controllers with battery-backed write cache

All other controllers without battery-backed write cache

++++100:0

––++90:10

––++80:20

–+––75:25

––++70:30

––++60:40

–+++50:50

––+–40:60

––+–30:70

–++–25:75

–––+0:50*

––+–0:75*

–+––0:100

* The cache ratio percentages do not total 100 in these cases because the additional 16-MB or 48-MB cache modules are not used. Only the battery-backed write cache is used.

RebuildPriority, ExpandPriority

These options have three possible values: Low, Medium, and High.

SSPState

There are two settings for this option: Enable and Disable. If you do not specify a value for the SSP State, the existing setting remains the same.

36 Scripting Toolkit utilities

NOTE: The SSPState option is valid only for controllers that enable SSP on a controller basis,

such as the MSA1000 or the Smart Array Cluster Storage controllers. RA4x00 controllers support SSP that is enabled on a logical drive basis, and use the LogicalDriveSSPState option (page 39) instead.

If you enable SSP, you must also specify an adapter for one or more logical drives by using the SSPAdaptersWithAccess option (page 40). Otherwise, SSP is automatically disabled.

SurfaceScanDelay

Enter a number between 1 and 30 to specify the duration of the surface scan delay in seconds.

Video performance options

To optimize the controller performance for video, set values for the following options as indicated:

DPOEnable = No ElevatorSortEnable = Yes IRPEnable = No

In addition, do the following:

• Set the MNPDelay to any integer value from 1 to 60 (units are minutes). If you want to disable

this option, set a value of zero instead.

• Set the QueueDepth to any integer value from 2 to 32, or to Auto.

Array category

The Array category has the following options:

• “Array” (page 37)

• “Drive” (page 37)

• “DriveType” (page 38)

• “OnlineSpare” (page 38)

Array

Enter a letter or pair of letters to identify the array you are creating or reconfiguring, and observe these additional limitations:

• In Configure mode, HP SSA creates a new array. The value that you specify for the array

option must be the next available letter or pair of letters in the sequence, according to the number of existing arrays on the controller. AA follows Z, and BA follows AZ.

• In Reconfigure mode, HP SSA can either create a new array or reconfigure an existing array.

In this case, the value that you specify can identify an existing array, or it can correspond to the next available array letter or pair of letters in the existing configuration.

Drive

You can use this option to add a drive to an existing array (to expand an array) or to build a new array. If you are expanding an array, each drive that you add must have a capacity no less than that of the smallest drive already in the array. The added and existing drives in the array must all be the same type (for example, SAS or SATA).

If the value of the ClearConfigurationWithDataLoss option is Yes, you can use the Drive option to remove drives from an array. However, the ClearConfigurationWithDataLoss option is now deprecated.

If you use Auto method mode, HP SSA configures all the available drives on the controller into one array. If the drives are of different capacities, HP SSA determines the capacity of the smallest drive and uses the same amount of space on all other available drives.

Using HPSSASCRIPTING 37

If you use Custom method mode, choose one of the following methods to specify the drives to be used in the array. Different arrays on the same controller can use different methods.

• To specify individual drives, use the applicable convention (port:ID, box:bay, or port:box:bay).

• To specify only the number of drives to use (not which specific drive IDs to use), enter that

number as the value for this option. For example, if you enter drive=3, HP SSA uses the first three available drives to build or expand the array that you define in the remainder of the script. HP SSA automatically determines which drives are suitable to use.

• To use all available drives, enter an asterisk as the value for this option. An array that is

configured using this method cannot have a spare.

DriveType

The value that you enter for this option specifies the type of drive (SAS, SATA, or parallel SCSI) that HP SSA must use to build the array.

OnlineSpare

The value for this option determines whether the array specified previously in the script will be configured with spare drives.

Default valuePossible valuesMethod mode

Custom

Auto

Logical Drive category

The Logical Drive category has the following options:

• “ArrayAccelerator” (page 39)

• “LogicalDrive” (page 39)

• “LogicalDriveSSPState” (page 39)

• “ParityGroups” (page 39)

use the applicable convention (port:ID, box:bay, or port:box:bay).

exact IDs), enter that number as the value for this option. HP SSA automatically selects only those drives that are suitable for the array.

To specify that the array should not have spares, enter None.

Yes (indicating one spare) No

In Configure action mode: None.To specify exactly which drives to use as spares, In Reconfigure action mode, HP SSA ignores any

value entered for this option and keeps any spares that are already present in the configuration.To specify only the number of spares (not the

In Configure action mode: Yes (indicating one spare).

In Reconfigure action mode, HP SSA ignores any value entered for this option and keeps any spares that are already present in the configuration.

• “PreferredPath” (page 39)

• “RAID” (page 39)

• “Sectors” (page 40)

• “Size” (page 40)

• “SSPAdaptersWithAccess” (page 40)

• “StripeSize” (page 40)

38 Scripting Toolkit utilities

ArrayAccelerator

This option specifies whether the array accelerator is enabled or disabled for the specified logical drive. The default value is Enabled.

LogicalDrive

The value that you enter for this option specifies the ID number of the logical drive that is to be created or modified. The first logical drive on an array must have an ID of 1 (not 0), and logical drive numbering must be contiguous.

• In Configure action mode, HP SSA accepts only the ID number of the next possible logical

drive.

• In Reconfigure action mode, HP SSA also accepts the ID number of any existing logical drive.

LogicalDriveSSPState

This option is valid only for controllers that enable SSP on a logical drive basis. Other controllers that support SSP use the SSPState option (page 36).

The following defaults apply:

• For new logical drives, the default value is Disabled.

• For existing logical drives, the default value is the current logical drive setting.

ParityGroups

When you create a RAID 50 or RAID 60 configuration, you must also set the number of parity groups.

You can use any integer value greater than 1 for this setting, with the restriction that the total number of physical drives in the array must be exactly divisible by the number of parity groups.

The maximum number of parity groups possible for a particular number of physical drives is the total number of drives divided by the minimum number of drives necessary for that RAID level (three for RAID 50, four for RAID 60).

PreferredPath

If you select the Manual setting for PreferredPathMode, use the PreferredPath command to specify the path for I/O to the logical drive on a redundant controller in active/active mode.

The default setting for this option is 1. With this setting, the controller in chassis slot 1 is the preferred controller for I/O to the logical drive. If you select 2, the controller in chassis slot 2 becomes the preferred controller for the logical drive.

To determine the chassis slot numbers, use the show command on a controller that supports redundant controllers.

RAID

The value that you enter for this option specifies the RAID level of the logical drive.

• When the Action mode is Configure, and the Method mode is Auto, HP SSA automatically

selects the highest RAID level that the controller and drive configuration can support except RAID 50 or RAID 60. To specify RAID 50 or 60 for a controller that supports either of these RAID levels, use the Custom setting. In this case, you must also specify the number of parity groups (page 39).

• When the Action mode is Reconfigure, the default value is the existing RAID level for that

logical drive. If you specify a different RAID setting, then HP SSA either ignores the new setting (when Method mode is Auto), or attempts to migrate the logical drive to the specified RAID level (when Method mode is Custom).

Using HPSSASCRIPTING 39

Sectors

This option specifies the number of sectors that are to comprise each track. Enter 32 to disable MaxBoot or 63 to enable it.

• For new logical drives, the default setting is 63 if the logical drive is larger than 502 GB.

Otherwise, the default setting is 32.

• For an existing logical drive, the default setting is the existing setting.

Logical drive performance is likely to decrease with MaxBoot enabled.

Size

Enter the capacity that you want the logical drive to have, in megabytes. The default size setting for new logical drives is MAX. In this case, HP SSA creates a logical drive of the maximum possible size from the physical drives that you assigned to the array.

In Reconfigure mode, the default setting is the existing size of the logical drive. If you enter a larger value, HP SSA extends the logical drive to the new size if there is unused drive capacity on the same array, as long as the operating system supports logical drive extension. You cannot reduce the size of the logical drive.

CAUTION: Back up all data before extending a logical drive.

SSPAdaptersWithAccess

Enter values here to identify the SSP adapters that you want to have access to a logical drive. The values are processed only if either SSPState or LogicalDriveSSPState is set to Enable. Otherwise, the values are ignored.

NOTE: Be sure that every HBA in the system has access to the logical drives for which multi-path

will be used.

StripeSize

You can enter a numerical value for this option to specify the size of the data stripes (in kilobytes), or you can leave this option blank and allow HP SSA to use a default value.

The valid stripe size values depend on the RAID level.

• For RAID 0, RAID 1, or RAID 1+0 arrays, you can enter any of the stripe size values listed in

the sample script.

• For RAID 5 arrays, the maximum stripe size in most cases is 256 KB, but old controller models

are often limited to 64 KB.

• For RAID 6 arrays, the maximum stripe size is either 64 KB or 256 KB, depending on the

controller.

The default stripe size value depends on the action mode.

• In Configure action mode, the default value is determined by the RAID level that you specified

earlier in the script. In some cases, it also depends on the HP SSA version, the controller model, and the controller firmware version.

◦ For RAID 0, RAID 1, or RAID 1+0, the default value is 128 KB.

◦ For RAID 5, the default value is usually 64 KB, but on some controller models it is 16 KB

or 128 KB.

◦ For RAID 6, the default value is usually 16 KB, but on some controller models it is 64 KB

or 128 KB.

• In Reconfigure action mode, the default value for this option is the stripe size that is already

configured for the logical drive. If you enter a value that is different from the existing stripe

40 Scripting Toolkit utilities

HBA category

The HBA category has the following options:

• “ConnectionName” (page 41)

• “HBA_WW_ID” (page 41)

• “HostMode” (page 41)

ConnectionName

This option is a user-defined string used as the connection name for the specified HBA. The string can consist of the following:

• A maximum of 16 characters

• Embedded space characters but cannot end with a space character

• Any of the following characters: a–z, A–Z, 0–9, !, @, #, *, (, ), -, _, +, :, ., /, and [space]

HBA_WW_ID

This option specifies which HBA, based on its assigned WWN, is modified by the configuration changes.

size, HP SSA attempts to migrate the logical drive to the stripe size that you specify. (If you intend to migrate the logical drive, back up all data before starting the migration procedure.)

HostMode

This option specifies the HostMode for a selected HBA. Setting the Host Mode optimizes the storage array for the selected operating system. The available host modes for an HBA are device-specific. Not all modes are available on all devices. Not all HBAs support a HostMode.

The following operating system options might be available:

• Default

• Microsoft Windows

• OpenVMS

• Tru64

• Linux

• Solaris

• Netware

• HP-UX

HP SSA scripting error messages

General error.1

Comment or clarificationError messageError code

The HP SSA process cannot be initiated. You might see this error message if you are not authenticated to use HP SSA or if HP SSA is already running.

278-282

HP SSA cannot save one or more controller configurations.Error saving controller.268

—Controller is locked by another machine or

user.

—Error communicating with controller.290

Using HPSSASCRIPTING 41

Comment or clarificationError messageError code

1053

1065-1066

1093

Internal error.516

Array requires an odd number of drives.1052

Cannot remove physical drives from existing array.

Too many coinciding expansion, migration, or extension operations.

license keys.

Slot information is not available.1102

An error occurred during the configuration process, but HP SSA cannot identify the error because there is an internal HP SSA error.

This error message occurs if you attempt to add an odd number of drives to an array that has RAID 1 logical drives, and the controller does not support RAID-level migration.

This error message occurs if a script that is running in Reconfigure action mode lists fewer physical drives than already exist in the array. HP SSA interprets this script as a request to remove physical drives from an existing array, but satisfying this request causes data loss, so HP SSA prevents the script from running.

HP SSA does not support multiple simultaneous expansions, migrations, or extensions without saving the configuration between operations. Limit the number of such configuration changes in the script.

—Controller does not support SSP.1091

—Controller requires physical drives to set

You cannot run a script in Input mode on internal controllers that do not have slot information online. Systems running Microsoft Windows must have the System Management Driver loaded.

1112

1114

2564

keys.

drives to set license keys.

user.

No controllers detected.2821

Invalid read cache/write cache ratio.2822

Invalid expand priority.2824

—Controller does not support license keys.1110

—Invalid license key.1111

—Controller has maximum number of license

—Controller requires non-failed physical

—Controller is locked by another machine or

The scripted Method value is not valid.Invalid Method.2818

The scripted controller does not match any existing controllers.Invalid Controller.2819

—Could not detect controller <text>.2820

This error applies to Input mode only. If no controllers are detected in Capture mode, the capture file is empty.

The specified cache ratio is not supported by either the controller or the current controller configuration.

—Invalid rebuild priority.2823

This error message appears if the expand priority value specified in the script is not supported. This message also appears if expansion is not possible because the Expand Priority feature is then not supported. Expansion might be temporarily unavailable on a controller that normally supports expansion if, for example, the cache battery has low charge, another expansion or migration is already in progress, or the array has the maximum supported number of physical drives.

42 Scripting Toolkit utilities

The array ID is invalid.Invalid array.2825

Comment or clarificationError messageError code

2827

Array not specified.2826

New array ID does not match the next available array ID.

New array ID already exists.2828

Cannot create array.2829

Cannot expand array.2830

Cannot change array spare.2831

Invalid physical drive.2832

Invalid spare.2833

The script file has commands that require an array, but no array is specified.

The scripted array ID is not the next ID in sequence, based on the IDs of the existing arrays. For example, only array A exists and the script file specifies creation of array C (omitting array B).

This error occurs in Configure mode when the array ID specified in the script file already exists in the configuration. In Configure mode, you can create only new arrays.

The controller has no unassigned physical drives, or it already has the maximum number of arrays or logical drives.

The controller does not support expansion, or the current controller configuration is not expandable.

This error message appears if you try to change the number of spares in an array when the configuration does not support the addition or subtraction of spares.

A specified physical drive is not a valid physical drive, or it cannot be placed in the array.

A specified spare is not a valid spare drive, or it cannot be placed in the array as a spare.

—Invalid logical drive.2834

2836

Logical drive not specified.2835

New logical drive ID does not match the next available logical drive ID.

New logical drive ID already exists.2837

Cannot create logical drive.2838

Cannot migrate logical drive RAID.2839

Cannot migrate logical drive stripe size.2840

Cannot extend logical drive.2841

The script file has commands that require a logical drive, but no logical drive is specified.

The script file specifies a logical drive ID that is not the first unused ID in the sequence. For example, this message appears if the controller has only logical drive 1 and the script file specifies creation of logical drive 3 (omitting logical drive 2). A common cause of this error is that the input file specifies non-sequential logical drive numbers. In this case, change the logical drive numbers in the input file so that they are sequential.

This error occurs in Configure mode when the logical drive ID specified in the script file already exists in the configuration. In Configure mode, you can create only new logical drives.

The array has no free space, or the maximum number of logical drives has already been reached.

The controller does not support RAID migration, or migration is not possible with the current controller configuration.

The controller does not support stripe size migration, or migration is not possible with the current controller configuration.

The controller does not support extension, or the current controller configuration cannot be extended. For example, extension is not possible if the array has no free space.

Invalid RAID.2842

Invalid size.2843

The specified RAID level is invalid or is not possible with the current configuration.

The specified size is invalid or is not possible with the current configuration.

Using HPSSASCRIPTING 43

Comment or clarificationError messageError code

2848

2849

Invalid stripe size.2844

Invalid sectors.2845

Cannot change logical drive sectors.2846

Invalid array accelerator setting.2847

Cannot change logical drive array accelerator setting.

parameter.

Invalid RAID Array ID.2851

The specified stripe size is invalid, or not supported by the current RAID level, or not possible with the current configuration.

The specified MaxBoot setting is invalid or is not possible with the current configuration.

You cannot change the MaxBoot setting on a configured logical drive because doing so causes data loss.

The specified array accelerator setting is invalid or is not supported by the current configuration.

You cannot change the array accelerator setting for the current controller configuration.

—Invalid ClearConfigurationWithDataLoss

—Controller does not support RAID Array ID.2850

The scripted RAID Array ID is invalid. Use characters from the set a–z, A–Z, 0–9, !, @, #, *, (, ), ,, -, _, +, :, ., /, and [space]. The ID cannot end with a space character or exceed the maximum number of characters allowed by the controller.

—Invalid SSP state.2852

—Cannot change SSP settings.2853

2855

2856

2861

SSP states. Use the SSPState controller command to set the controller SSP state.

state. Use the LogicalDriveSSPState logical drive command to set SSP states for each logical drive.

Controller does not support redundancy settings.

Invalid preferred path mode.2864

Invalid preferred path.2865

<text> command expected.2869

—Invalid SSP adapter ID.2854

—Controller does not support logical drive

—Controller does not support controller SSP

—Invalid surface scan delay.2857

The controller is not redundant or does not support redundancy settings.

The specified value for the preferred path mode is not valid, or the controller is not available.

The specified preferred path is not a valid chassis slot for an available active controller, or the controller is not available.

—Failure opening capture file <text>.2866

—Failure opening input file <text>.2867

—Failure opening error file <text>.2868

The <text> command is missing or in the wrong place in the script file.

<text> is not a Controller command.2871

<text> is not an Array command.2872

44 Scripting Toolkit utilities

—<text> is not a supported command.2870

The <text> command does not belong in the Controller section of the script file.

The <text> command does not belong in the Array section of the script file.

Comment or clarificationError messageError code

2875

2882

2883

2884

<text> is not a Logical Drive command.2873

<text> is not an HBA command.2874

exist in the same section.

Invalid physical drive count.2876

No spares available.2877

Reset and reconfigure combined error.2879

is 0 (disabled) to 60 minutes.

Expecting Yes or No.

is from 2 to 32, or Auto.

The <text> command does not belong in the Logical Drive section of the script file.

The <text> command does not belong in the HBA section of the script file.

—More than one <text> command cannot

The script specifies more drives than are available of the specified drive type.

No drives were found that could be used as spares for the specified array.

RAID 0 does not support spares.Spare request for RAID 0 is invalid.2878

A controller reset with data loss was specified while in Reconfigure mode.

—Invalid drive type specified.2880

—Invalid value for MNPDelay. Valid range

—Invalid controller configuration value.

—Invalid value for QueueDepth. Valid range

Using HPLPCFG

You must edit the text file to insert the WWID of the boot volume and the LUN number that the WWID boots from. The HPLPCFG utility discovers the WWID of the HBA in the server blade and writes the information in the text file. The text file presents the options in human readable format. The HPLPCFG utility updates the hardware with the boot volume WWID and boot LUN read from the text file.

HPLPCFG command-line syntax

hplpcfg —s filename hplpcfg —l filename hplpcfg —v

[HBA0] WWID=11223344 HostAdapterBiosEnable=1 SelectBootEnable=1 BootDeviceWWID=22334455 BootDeviceLUN[0]=1111

HPLPCFG command-line arguments

hplpcfg —s filename

hplpcfg —l filename

hplpcfg —v

Where filename has the following format:

DescriptionCommand-line argument

This argument saves the HBA configuration to the filename.

This argument loads the HBA configuration to the filename.

This argument displays the tool version information.

[HBA0]

WWID=11223344

HostAdapterBiosEnable=1

SelectBootEnable=1

Section for each HBA

Read-only variable

Your input or current value when read from HBA

Using HPLPCFG 45

DescriptionCommand-line argument

BootDeviceWWID=22334455

BootDeviceLUN[0]=1111

HPLPCFG return codes

MeaningValue

The command was completed successfully.

There was an invalid command line option.

There was a file open error.

There was an NVRAM checksum error.

There was an NVRAM data error.

There was no adapter or Emulex HBA found on this host.

There was an error retrieving the I/O address.

The WWID was invalid because of one of the following:

• An invalid value for WWID and BootDeviceWWID, and not a hex value

• The WWID specified for HBA in the .ini file does not match any HBAs found on the host (for the

/l option only)

Your input or current value when read from HBA

Your input, default LUN, or current value when read from HBA

0x10

0x11

0xFF

The LUN was invalid.

Invalid value; for enable/disable value is not 0 or 1 (for /l option only)

Incorrect iboot BIOS code loaded (for /l option only)

General error:

• Initialization error (for both /l and /s option)

• Cannot read HBAs WWPN (for /s option only)

HPLPCFG command-line examples

hplpcfg –s hba.ini generates hba.iniwith the following content:

[HBA0] WWID=11111111 HostAdapterBiosEnable=1 SelectBootEnable=1 BootDeviceWWID= BootDeviceLUN[0]=

You must edit hba.ini and add the following boot device information:

[HBA0] WWID=11111111 HostAdapterBiosEnable=1 SelectBootEnable=1 BootDeviceWWID=22222222 BootDeviceLUN[0]=3

46 Scripting Toolkit utilities

You must then invoke the tool to load the contents of hba.ini input to the HBA NVRAM: hplpcfg /l hba.ini.

Using LO100CFG

NOTE: This section applies only to HP ProLiant servers not using the Oxx ROM family.

LO100CFG enables you to configure the LightsOut 100 device that is available on the HP ProLiant 100 series servers.

Under Windows, WMI is used through the Microsoft_IPMI class, make sure WMI is installed in the Windows PE environment.

LO100CFG command-line syntax

lo100cfg [ -h | -x | -v | -i "file.xml" | -o "file.xml" | -s ]

LO100CFG command-line arguments

DescriptionCommand-line argument

-x

-v

-s

-h

-i "file.xml"

-o "file.xml"

-k "<xml/>"

LO100CFG return codes

This argument displays example XML to perform configuration.

This argument outputs the current copyright and version information and then exits.

This argument captures the current status and outputs it to the console.

The argument lists basic command line arguments and supported XML tags.

This argument loads and runs the given XML configuration file.

This argument saves the current configuration to a file.

This argument has been deprecated and is no longer supported.

MeaningValue

All operations succeeded.

A required command-line parameter is missing. See console output for details.

101

An unknown command-line parameter was passed to the utility.

File error. The specified file is empty or not found.

Syntax error. You must specify exactly one option from -i

-o -s.

An invalid command-line parameter was passed to the utility.

Invalid command-line syntax was used.

The IPMI driver may not be loaded or installed properly.

XML failed validity tests.

Using LO100CFG 47

MeaningValue

102

103

104

NOTE: Return codes of 100 or higher are returned from the LO100 processor.

LO100CFG command-file contents

A typical data file generated by LO100CFG is similar to the following:

To disable the shared NIC configuration and make the Lights-Out 100 NIC dedicated, enter the following in your data file:

Field in the XML file has invalid values. Valid fields still applied.

The Lights Out 100 returned a code the application did not expect. See console output for code returned from the LO100 processor.

System is unsupported or is not running IPMI drivers.

Using HPQLAREP

You must edit the text file to insert the WWID of the boot volume and the LUN number that they will boot from. The hpqlarep utility discovers the WWID of the HBA in the server blade and writes the information in the text file. The text file presents the options in human readable format. The hpqlarep utility updates the hardware with the boot volume WWID and boot LUN read from the text file.

HPQLAREP command-line syntax

hpqlarep —s filename hpqlarep —l filename

[HBA0] WWID=11223344 HostAdapterBiosEnable=1 SelectBootEnable=1 BootDeviceWWID=22334455 BootDeviceLUN[0]=1111

48 Scripting Toolkit utilities

HPQLAREP command-line arguments

DescriptionCommand-line argument

hpqlarep —s filename

hpqlarep —l filename

Where filename has the following format:

[HBA0]

WWID=11223344

HostAdapterBiosEnable=1

SelectBootEnable=1

BootDeviceWWID=22334455

BootDeviceLUN[0]=1111

HPQLAREP return codes

This argument saves the HBA configuration to the filename.

This argument loads the HBA configuration to the filename.

Section for each HBA

Read-only variable

Your input

Your input and default LUN

MeaningValue

The command was completed successfully.

There was an invalid command line option.

There was a file open error.

There was an NVRAM checksum error.

There was an NVRAM data error.

There was no adapter found on this host.

There was an error retrieving the I/O address.

The WWID was invalid.

The LUN setting was invalid.

The EFI Enable Selective LUN setting was invalid.

The BIOS Enable setting was invalid.

The Selectable BIOS setting was invalid.

The EFI Selective login settings were invalid.

The EFI WWID (Boot Node Name) was invalid.

There was a Memory Allocation error.

The adapter has no VPD.

There was a failure reading the adapter VPD.

The adapter has no VPD.

VPD has bad checksum.

The adapter serial number is missing in the VPD.

Using HPQLAREP 49

HPQLAREP command-line examples

hpqlarep —s hba.ini generates hba.ini with the following content:

[HBA0] WWID=11111111 HostAdapterBiosEnable=1 SelectBootEnable=1 BootDeviceWWID= BootDeviceLUN[0]=

You must edit hba.ini and add the following boot device information:

[HBA0] WWID=11111111 HostAdapterBiosEnable=1 SelectBootEnable=1 BootDeviceWWID=22222222 BootDeviceLUN[0]=3

You must then invoke the tool to load the contents of hba.ini input to the HBA NVRAM: hpqlarep

–l hba.ini.

Using HPONCFG

HP offers support for the iLO features available on HP ProLiant servers with the HPONCFG utility. HPONCFG is an online configuration tool used to set up and reconfigure iLO without requiring a

reboot of the server operating system. The utility runs in a command-line mode and must be executed from an operating system command line.

HPONCFG enables you to initially configure features exposed through the RBSU or iLO. This utility is not intended for continued administration. CPQLOCFG should be used for ongoing administration of user rights and network functionality on the server.

Before using HPONCFG, the iLO Management Interface Driver must be loaded on the server. HPONCFG displays a warning if the driver is not installed.

For more information, see the HP iLO website at http://www.hp.com/go/ilo. Also, see the HP iLO 4 Scripting and Command Line Guide (for Gen8 servers) on the HP website

at http://www.hp.com/go/proliantgen8/docs or the HP ProLiant Integrated Lights-Out 3 v1.20 Scripting and Command Line Guide (for G7 servers) on the HP website at www.hp.com/go/ilo.

HPONCFG command-line syntax

hponcfg [-help][/?][-reset][-f filename][-l filename] [-w filename][-get_hostinfo][-m firmwarelevel]

IMPORTANT: Because the -w argument does not capture certain types of information, such as

the administrator password, data files created with HPONCFG using the -w argument cannot then be used as input files for HPONCFG, unless they are modified first.

HPONCFG command-line arguments

/help or /h

-reset

50 Scripting Toolkit utilities

DescriptionCommand-line argument

These arguments display simple help messages.

This argument resets the iLO to factory defaults.

DescriptionCommand-line argument

-f

filename

-l

filename

-w

filename

-get_hostinfo

-m

-mouse

NOTE: For a complete list of all command-line parameters, execute the /h utility.

HPONCFG return codes

This argument sets the iLO configuration based on the information in the XML input file named filename.

This argument logs replies to the text log file named

filename.

This argument writes the iLO configuration obtained from the device to the XML output file named filename.

This argument returns the host server name and serial number.

This argument indicates to HPONCFG the minimum firmware level that must be present in the management device to execute the RIBCL script. If the minimum level is not met, HPONCFG returns an error without performing any additional actions.

This argument causes HPONCFG to configure the server for optimized mouse handling.

MeaningValue

If the script itself fails, errors are reported in the log file created by HPONCFG.

HPONCFG command file contents

HPONCFG can be used to perform the following tasks:

• Obtain an entire configuration

• Obtain a specific configuration

• Set a configuration

Obtaining an entire configuration

HPONCFG can be used to obtain an entire configuration from iLO. In this case, the utility executes from the command line without specification of an input file. The name of the output file is given on the command line. For example:

hponcfg -w config.xml

In this example, the utility indicates that it obtained the data successfully and wrote it to the output file as requested. The following is a typical example of the contents of the output file:

The script was sent successfully to the device.

The script could not be sent to the device.

Using HPONCFG 51

<DIR_OBJECT_DN VALUE = " "/> <DIR_OBJECT_PASSWORD VALUE = ""/> <DIR_USER_CONTEXT_1 VALUE = ""/> <DIR_USER_CONTEXT_2 VALUE = "_"/> <DIR_USER_CONTEXT_3 VALUE = ""/> </MOD_DIR_CONFIG> <MOD_NETWORK_SETTINGS> <SPEED_AUTOSELECT VALUE = "Y"/> <NIC_SPEED VALUE = "100"/> <FULL_DUPLEX VALUE = "Y"/> <IP_ADDRESS VALUE = "11.222.333.444"/> <SUBNET_MASK VALUE = "222.222.222.0"/> <GATEWAY_IP_ADDRESS VALUE = "11.100.200.2"/> <DNS_NAME VALUE = "ILOD234KJ44D002"/> <PRIM_DNS_SERVER value = "16.16.1.161"/> <DHCP_ENABLE VALUE = "Y"/> <DOMAIN_NAME VALUE = "americas.cpqcorp.net"/> <DHCP_GATEWAY VALUE = "Y"/> <DHCP_DNS_SERVER VALUE = "Y"/> <DHCP_STATIC_ROUTE VALUE = "Y"/> <DHCP_WINS_SERVER VALUE = "Y"/> <REG_WINS_SERVER VALUE = "Y"/> <PRIM_WINS_SERVER value = "16.16.6.161"/> <STATIC_ROUTE_1 DEST = "0.0.0.0" GATEWAY = "0.0.0.0"/> <STATIC_ROUTE_2 DEST = "0.0.0.0" GATEWAY = "0.0.0.0"/> <STATIC_ROUTE_3 DEST = "0.0.0.0" GATEWAY = "0.0.0.0"/> </MOD_NETWORK_SETTINGS> <ADD_USER USER_NAME = "Administrator" USER_LOGIN = "Administrator" PASSWORD = ""> </ADD_USER> <ADD_USER USER_NAME = "Landy9" USER_LOGIN = "mandy9" PASSWORD = ""> </ADD_USER> <RESET_RIB VALUE = "Y"/> </HPONCFG>

For security reasons, the user passwords are not returned.

Obtaining a specific configuration

A specific configuration can be obtained using the appropriate XML input file. For example, the contents of a typical XML input file, get_global.xml, are the following:

<RIBCL VERSION="2.0"> <LOGIN USER_LOGIN="x" PASSWORD="x"> <RIB_INFO MODE="read">

52 Scripting Toolkit utilities

<GET_GLOBAL_SETTINGS /> </RIB_INFO> </LOGIN> </RIBCL>

The XML commands are read from the input file

get_global.xml

and are processed by the device:

HPONCFG /f get_global.xml /l log.txt > output.txt

The requested information is returned in the log file, which, in this example, is named log.txt. The contents of the log file are as follows:

<GET_GLOBAL_SETTINGS> <SESSION_TIMEOUT VALUE="30"/> <ILO_FUNCT_ENABLED VALUE="Y"/> <F8_PROMPT_ENABLED VALUE="Y"/> <REMOTE_CONSOLE_PORT_STATUS VALUE="3"/> <REMOTE_CONSOLE_ENCRYPTION VALUE="N"/> <PREFER_TERMINAL_SERVICES VALUE="N"/> <HTTPS_PORT VALUE="443"/> <HTTP_PORT VALUE="80"/> <REMOTE_CONSOLE_PORT VALUE="23"/> <TERMINAL_SERVICES_PORT VALUE="3389"/> <VIRTUAL_MEDIA_PORT VALUE="17988"/> <MIN_PASSWORD VALUE="4"/> </GET_GLOBAL_SETTINGS>

Setting a configuration

A specific configuration can be sent to the iLO by using the command format:

HPONCFG /f add_user.xml /l log.txt

In this example, the input file has the following contents:

<RIBCL version="1.2"> <LOGIN USER_LOGIN="x" PASSWORD="x"> <USER_INFO MODE="write"> <ADD_USER USER_NAME="Landy9" USER_LOGIN="mandy9" PASSWORD="floppyshoes"> <RESET_SERVER_PRIV value="Y" /> <ADMIN_PRIV value="Y" /> </ADD_USER> </USER_INFO> </LOGIN> </RIBCL>

The specified user will be added to the device.

HPONCFG command-line examples

For HPONCFG command line examples, see the appropriate user guide on the HP iLO website at http://www.hp.com/go/ilo.

Using HPONCFG 53

5 Troubleshooting

Troubleshooting table

TroubleshootingIssue

Data loss in STK

Configuring options using STK utilities

Input files for HPONCFG

Sample script files

HP ProLiant drivers

Improper use of the Scripting Toolkit utilities and modification of the CONREP data files can result in loss of critical data. Because of the potential data-loss risk, only experienced individuals should use the Scripting Toolkit utilities. Before using the Scripting Toolkit, all necessary precautions must be taken to ensure that mission-critical systems remain online if a failure occurs.

Not all options can be configured using Scripting Toolkit utilities. Some options must be configured manually or with other configuration utilities, which are available online, before they can be used with the Scripting Toolkit. For more information on configuration, see the option documentation.

Because the -w argument does not capture certain types of information, such as the administrator password, data files created with HPONCFG using the -w argument cannot then be used as input files for HPONCFG, unless they are modified first.

The script files and script segments in this guide are provided only as examples. You must modify the scripts for your environment. When creating or modifying your own scripts, the pause command is a valuable tool to help you determine that each step of the script is functioning as desired.

HP ProLiant drivers must be added during Windows PE customization to ensure the Scripting Toolkit utilities function properly. See the readme.txt file provided.

WMI support

Non-functioning IFHW

CONREP version compatibility

HPSSASCRIPTING support

HPRCU compatibility

Booting from a USB drive key

Customizing the DEPLOYSERVER.CMD script

SETBOOTORDER changes

HP software requires that WMI support be enabled to function in Windows PE properly.

IFHW is case-sensitive. Incorrect case, misspellings, and incorrect spacing cause the query to fail.

The file format for the DOS version of CONREP and the current version of CONREP are not compatible.

HPSSASCRIPTING supports only HP Smart Array controllers. Review the HPSSASCRIPTING documentation for the latest information.

HPRCU is not compatible with UEFI-based HP ProLiant servers. Use CONREP instead.

Booting from a USB drive key is supported only on certain HP ProLiant servers. For more information, see the HP Support Center and search Insight Foundation suite for ProLiant website:http://h20566.www2.hp.com/portal/

site/hpsc/.

The IFHW and HWQUERY utilities can be used to customize the DEPLOYSERVER.CMD script for your environment. For more information about these utilities, see

“Scripting Toolkit utilities” (page 16).

Any changes you make to the SETBOOTORDER will take effect at the next reboot.

54 Troubleshooting

6 Support and other resources

Information to collect before contacting HP

Be sure to have the following information available before you contact HP:

• Software product name

• Hardware product model number

• Operating system type and version

• Applicable error message

• Third-party hardware or software

• Technical support registration number (if applicable)

How to contact HP

Use the following methods to contact HP technical support:

• See the Contact HP worldwide website:

http://www.hp.com/go/assistance

• Use the Contact hp link on the HP Support Center website:

http://www.hp.com/go/hpsc

• In the United States, call +1 800 334 5144 to contact HP by telephone. This service is available

24 hours a day, 7 days a week. For continuous quality improvement, conversations might be recorded or monitored.

Subscription service

HP recommends that you register your product at the Subscriber's Choice website at http://

www.hp.com/country/us/en/contact_us.html. After registering, you will receive email notification

of product enhancements, new driver versions, firmware updates, and other product resources.

Related information

For support software, drivers and firmware, see the HP software and drivers website at http://

www.hp.com/go/hpsc. HP also recommends installing the latest version of the HP SPP, which

contains system software, drivers, and firmware for HP ProLiant servers and BladeSystem infrastructure. To obtain the most current SPP, see the SPP website at http://www.hp.com/go/spp.

For information on the latest Scripting Toolkit, see the additional documentation found on the Scripting Toolkit website at http://www.hp.com/go/ProLiantSTK.

For information on the previous SmartStart Scripting Toolkit, which was used for HP ProLiant G7 and earlier servers and BladeSystems, see the documentation found on the HP website at http://

www.hp.com/go/foundation.

For more information on unattended installation, see the following resources:

• Operating system documentation

• Windows Server Technical Reference at http://technet.microsoft.com/en-us/library/

bb625087.aspx

Scripting Toolkit support

E-mail support for the Scripting Toolkit is available from the HP support website at http://

h18013.www1.hp.com/products/servers/management/toolkit/smartsetup_E-support.html.

Information to collect before contacting HP 55

Typographic conventions

Table 1 Document conventions

ElementConvention

Cross-reference links and e-mail addressesBlue text: Table 1 (page 56)

Website addressesBlue, underlined text: http://www.hp.com

Bold text

Monospace text

Monospace, italic text

• Keys that are pressed

• Text typed into a GUI element, such as a box

• GUI elements that are clicked or selected, such as menu

and list items, buttons, tabs, and check boxes

Text emphasisItalic text

• File and directory names

• System output

• Code

• Commands, their arguments, and argument values

• Code variables

• Command variables

Emphasized monospace textMonospace, bold text

CAUTION: Indicates that failure to follow directions could result in damage to equipment or data.

IMPORTANT: Provides clarifying information or specific instructions.

NOTE: Provides additional information.

TIP: Provides helpful hints and shortcuts.

HP Insight Remote Support software

HP strongly recommends that you register your device for remote support to enable enhanced delivery of your HP Warranty, HP Care Pack Service, or HP contractual support agreement. HP Insight Remote Support supplements your monitoring continuously to ensure maximum system availability by providing intelligent event diagnosis, and automatic, secure submission of hardware event notifications to HP, which will initiate a fast and accurate resolution, based on your product’s service level. Notifications may be sent to your authorized HP Channel Partner for onsite service, if configured and available in your country.

For more information, see HP Insight Remote Support and Insight Online Setup Guide for ProLiant Gen8 Servers and BladeSystem c-Class Enclosures on the HP website (http://www.hp.com/go/

enterprise/docs). HP Insight Remote Support is available as part of HP Warranty, HP Care Pack

Service, or HP contractual support agreement.

HP Insight Online

HP Insight Online is a capability of the HP Support Center portal. Combined with HP Insight Remote Support 7.x, it automatically aggregates device health, asset, and support information from iLO Management Engine with contract and warranty information, and then secures it in a single, personalized dashboard that is viewable from anywhere at any time. The dashboard organizes your IT and service data to help you understand and respond to that information more quickly.

56 Support and other resources

With specific authorization from you, an authorized HP Channel Partner can also view your IT environment remotely at HP Insight Online.

For more information, see the following documents on the HP website (http://www.hp.com/go/

insightremotesupport/docs):

• For more information about using HP Insight Online, see the HP Insight Online User’s Guide.

• For more information about installing HP Insight Remote Support and enabling HP Insight

Online, see the HP Insight Remote Support and Insight Online Setup Guide for ProLiant Gen8 Servers and BladeSystem c-Class Enclosures.

HP Insight Online 57

7 Documentation feedback

HP is committed to providing documentation that meets your needs. To help us improve the documentation, send any errors, suggestions, or comments to Documentation Feedback (docsfeedback@hp.com). Include the document title and part number, version number, or the URL when submitting your feedback.

58 Documentation feedback

Acronyms and abbreviations

ACU Array Configuration Utility ADG Advanced Data Guarding (also known as RAID 6) API application program interface BIOS Basic Input/Output System CONREP Configuration Replication utility CPQLOCFG Lights-Out Configuration Utility CQPSSAXE Smart Storage Administrator XE DHCP Dynamic Host Configuration Protocol DOS disk operating system GUI graphical user interface HBA host bus adapter HPDISCOVERY HP Discovery Utility HPONCFG HP Lights-Out Online Configuration utility HPQLAREP HP QLogic FC HBA BIOS configuration utility HPRCU HP ROM Configuration Utility HWQUERY Hardware Query Utility I/O input/output IFHW IF Hardware Utility iLO Integrated Lights-Out IP Internet Protocol IPL initial program load IPMI Intelligent Platform Management Interface LO100CFG Lights-Out (100 series) Online Configuration utility LUN logical unit number NIC network interface controller NVRAM non-volatile memory PCI peripheral component interface PXE Preboot Execution Environment RAID redundant array of inexpensive (or independent) disks RAM random access memory RBSU ROM-Based Setup Utility RIBCL Remote Insight Board Command Language ROM read-only memory SAS serial attached SCSI SATA serial ATA SCSI small computer system interface SPP HP Service Pack for ProLiant SSA Smart Storage Administrator SSP Selective Storage Presentation STATEMGR State Manager utility USB universal serial bus VPD vital product data

WMI Windows Management Instrumentation WOL Wake-on LAN WWID World Wide ID WWN World Wide Name WWPN worldwide port name XML extensible markup language

60 Acronyms and abbreviations

Index

acronyms and abbreviations, 59 array configurations

erasing, 15

clearing a configuration, 35 configuration

capturing, 30 target server, 11

configurations

capturing, 10

CONREP, 24

command file contents, 28 command-line arguments, 25 command-line syntax, 25 data file sample

HP ProLiant 100 series, 27

Load from Data file example

HP ProLiant 100 series, 26 return codes, 25 screen output, 26 Store to Data file example

HP ProLiant 100 series, 26

conventions

document, 56

deployment overview, 7 deployment procedure, 7 detecting a card family, 13 detecting a card or device, 12 document

conventions, 56

documentation

providing feedback on, 58

erasing array configurations, 15 expression examples, 23 expression operators and terms, 22

return codes, 21

HPLPCFG, 45

arguments, 45 command-line examples, 46 command-line syntax, 45 return codes, 46

HPONCFG, 50

arguments, 50 command file, 51

entire configuration, 51 setting a specific configuration, 53

specific configuration, 52 command-line examples, 53 command-line syntax, 50 return codes, 51

HPQLAREP, 48

arguments, 49 command-line examples, 50 command-line syntax, 48 return codes, 49

HPRCU, 28

arguments, 29 command-line syntax, 29 return codes, 29 sample XML format, 29

HPSSASCRIPTING, 30

configuration, 30 HP SSA script file, 31 HP SSA scripting errors, 41 input script, 31 sample input script, 31 script file options, 33

array category, 37

control category, 34

controller category, 34

HBA category, 41

logical drive category, 38

HWQUERY, 23

arguments, 23 command-line examples, 24 command-line syntax, 23 return codes, 24

features, 6 flashing the ROM, 13

HP Insight Online, 56 HP SSA script file, 31 HPDISCOVERY, 20

arguments, 20 command-line examples, 21 command-line syntax, 20 customizing deployment scripts, 12

queries, 12, 13

IFHW, 21

arguments, 22 command-line examples, 22 command-line syntax, 21 customizing deployment scripts, 12 return codes, 22

iLO, 50 installation

operating system, 11

LO100CFG, 47

arguments, 47 command file, 48 command-line syntax, 47 return codes, 47

logical drive capacity extension, 40

MaxBoot setting, 40

network share

creating, 8

online help, 16 Online ROM Flash Component Utility, 13 operating system

installation, 11

operators and terms, 22

RBSURESET, 19

arguments, 20 command-line syntax, 20 return codes, 20

REBOOT, 17

arguments, 17 command-line examples, 18 command-line syntax, 17 return codes, 17

ROM

updating, 13

video performance optimization, 37

websites, 55 Windows Preinstallation Environment, 6

adding drivers to version 3.0, 8 adding drivers to version 4.0, 9

Scripting Toolkit utilities, 16 SETBOOTORDER, 18

arguments, 18 command-line examples, 18 command-line syntax, 18 return codes, 18

STATEMGR, 19

arguments, 19 command-line examples, 19 command-line syntax, 19

return codes, 19 support, 55 syntax conventions, 16

target server

configuring, 11 technical support, 55 troubleshooting, 54 typographic conventions, 56

utilities

Scripting Toolkit, 16

62 Index

HP Scripting Toolkit for Windows 9.60 User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual

HP Scripting Toolkit for Windows 9.60 User Guide

Contents

1 Introduction

Scripting Toolkit for Windows

Microsoft Windows Preinstallation Environment

Minimum requirements

2 Deployment using the Scripting Toolkit for Windows

Deployment overview

Sample deployment procedure

Creating a network share

Adding drivers to Windows PE 3.0

Adding drivers to Windows PE 4.0

Capturing a reference configuration from the source server

Configuring the target server and installing the operating system

3 Advanced topics

Overview

Customizing deployment scripts using HPDISCOVERY and IFHW

Querying the HPDISCOVERY file based on system name

Querying the HPDISCOVERY file to determine the presence of a particular card

Querying the HPDISCOVERY file to determine the presence of a card family

Booting Windows PE from a USB drive key

Flashing the ROM in a Windows PE environment

Erasing array configurations

4 Scripting Toolkit utilities

Syntax conventions

Utility online help

Using Scripting Toolkit utilities

Using REBOOT

REBOOT command-line syntax

REBOOT command-line arguments

REBOOT return codes

REBOOT command-line examples

Using SETBOOTORDER

SETBOOTORDER command-line syntax

SETBOOTORDER command-line arguments

SETBOOTORDER return codes

SETBOOTORDER command-line examples

Using STATEMGR

STATEMGR command-line syntax

STATEMGR command-line arguments

STATEMGR return codes

STATEMGR command-line examples

Using RBSURESET

RBSURESET command-line syntax

RBSURESET command-line arguments

RBSURESET return codes

Using HPDISCOVERY

HPDISCOVERY command-line syntax

HPDISCOVERY command line arguments

HPDISCOVERY return codes

HPDISCOVERY command line examples

Using IFHW

IFHW command-line syntax

IFHW command-line arguments

IFHW return codes

IFHW command line examples

Expression operators and terms

Expression examples

Using HWQUERY

HWQUERY command-line syntax

HWQUERY command line arguments

HWQUERY return codes

HWQUERY command-line examples

Using CONREP

CONREP command-line syntax

CONREP command-line arguments

CONREP return codes

CONREP screen output

CONREP -s (Store to Data file)

CONREP –l (Load from Data File)

CONREP Data File Sample Contents for HP ProLiant servers not using the Oxx ROM family

CONREP command file contents

Using HPRCU

HPRCU command-line syntax

HPRCU command line arguments

HPRCU return codes