Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S.
Government under vendor’s standard commercial license.
The information contained herein is subject to change without notice. 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.
Microsoft, Windows, and Windows NT are U.S. registered trademarks of Microsoft Corporation. Linux is a U.S. registered trademark of Linus
Torvalds. UNIX is a registered trademark of the Open Group.
October 2005 (Fourth Edition)
Part Number 365441-004
New features in the toolkit.......................................................................................................................... 4
Deployment methods and installation requirements ........................................................................................4
Step 1: Creating a server profile .................................................................................................................5
Utility online help ....................................................................................................................................10
Using system utilities ................................................................................................................................ 10
Using REBOOT ............................................................................................................................. 10
Using STATEMGR.......................................................................................................................... 11
Using the Hardware Discovery Utility ............................................................................................... 11
Using IFHW.................................................................................................................................. 13
Using HWQUERY.......................................................................................................................... 16
Using media creation utilities .................................................................................................................... 17
Using BOOTSECT.......................................................................................................................... 17
Using configuration utilities....................................................................................................................... 18
Using CONREP.............................................................................................................................18
Using CPQACU ............................................................................................................................21
Using HPONCFG.......................................................................................................................... 29
Operating system information ................................................................................................................... 34
Toolkit support ........................................................................................................................................ 34
HP contact information............................................................................................................................. 35
Acronyms and abbreviations........................................................................................................ 36
New features in the toolkit......................................................................................................................... 4
Deployment methods and installation requirements....................................................................................... 4
Step 1: Creating a server profile ................................................................................................................ 5
Step 2: Creating a server deployment script ................................................................................................ 6
Step 3: Creating a server boot process ....................................................................................................... 7
Introduction
The SmartStart Scripting Toolkit includes a set of utilities for configuring and deploying servers in a
customized, predictable, and unattended manner. These utilities duplicate the configuration of a source
server on target servers with minimum user interaction. This guide describes the Toolkit utilities and
explains how the utilities interact to provide scripted server and array replication for mass server
deployment.
CAUTION: Improper use of the Toolkit utilities can result in loss of critical data. Because of the potential
data-loss risk, only experienced individuals should use the Toolkit utilities. Before using the Toolkit, all
necessary precautions must be taken to ensure that mission-critical systems remain online if a failure occurs.
New features in the toolkit
For a complete list of new features in the SmartStart Scripting Toolkit Linux and Win32 Editions, refer to
the "What's New" section of the Toolkit website (http://www.hp.com/servers/sstoolkit
).
For a list of supported servers, refer to the HP SmartStart Scripting Toolkit Linux and Win32 Editions Support Matrix on the Toolkit website (http://www.hp.com/servers/sstoolkit
).
Deployment methods and installation requirements
The following table summarizes deployment methods and the requirements for each method. For
additional information, refer to the SmartStart website (http://www.hp.com/servers/smartstart
Deployment
method
SmartStart Single-server installation
Toolkit
Type of installation Benefits Deployment requirements
High-volume deployment
using the CD as an
operating system source
Assistance during server
configuration and
software installation
Automated, unattended
deployment
• SmartStart CD Package
• Operating system to install
CDs with operating system and HP
support software
).
Deployment overview 4
Deployment
method
Toolkit
Toolkit
Toolkit with thirdparty imaging
applications
ProLiant Essentials
RDP
Type of installation Benefits Deployment requirements
High-volume deployment
using the network as an
operating system source
High-volume deployment
using RILOE II or iLO
High-volume deployment
using imaging
applications
High-volume deployment
from a central
deployment console
Automated, unattended
deployment with remote
installation over a
network
Automated, unattended
deployment with remote
installation over a
network
Automated, unattended
deployment with the
benefits of popular
imaging applications
Automated, unattended
remote deployment from
a remote location using
a GUI-based application
Network share with operating
system and HP support software
• RILOE II or iLO on target
servers
• Network share with operating
system and HP support
software
Third-party imaging application
Fee-based production license for
every target server deployed.
For additional information about
RDP, refer to the RDP website
(http://www.hp.com/servers/rdp
).
To use the Toolkit utilities to configure a target system, create a series of configuration data files from a
configured source server, edit the data files for the unconfigured target server, and then use the edited
files to deploy new servers.
New server deployment with the Toolkit includes:
1. Creating a server profile ("Step 1: Creating a server profile" on page 5)
2. Creating a server script file ("Step 2: Creating a server deployment script" on page 6)
3. Creating a server boot process ("Step 3: Creating a server boot process" on page 7) to set up a
Win32 or Linux installation environment
Step 1: Creating a server profile
The server profile for target servers is generated from an optimally configured source server. The server
profile consists of three main configuration files and an optional fourth file (for RILOE II or iLO) that are
edited to match the servers being deployed.
The server configuration files include:
•Unattended OS installation file—Contains unattended operating system software installation
information. This file is defined by the operating system installation process and is not created with
the Toolkit utilities. The user creates the unattended text file.
• Hardware data files—Contains server hardware configuration information.
• Array data file—Contains disk array configuration information.
• RILOE II or iLO data file (optional)—Contains data for boot-strapping a RILOE II or iLO board
or configuration to a server. This file is required only for customers who want to use the Toolkit to
configure RILOE II or iLO.
These configuration data files contain all the server configuration information and are utilized by the
server configuration and deployment script.
The unattended installation OS files are defined by the operating system installed on the server. The files
contain information required to partition the disks and run an unattended installation of the server
Deployment overview 5
operating system. They are created and customized by the user. This file is not required if the user is not
attempting an unattended installation.
The Toolkit has several utilities that create the configuration files for the hardware and array
configurations from an existing server. The Toolkit utilities read the configuration of a source server and
duplicate it on a target server through a generated script file. The configuration utilities needed to apply
the server profile are:
• CONREP—Generates the hardware data file
• ACU—Generates the array configuration data file
• HPONCFG—Generate the RILOE II or iLO data file
Configuration Replication Utility
CONREP generates a hardware configuration file based on the server on which it is initially run. Run the
configuration utility to create the hardware configuration data files that compose the server profile.
Array Configuration Utility
CPQACU creates a configuration script file that contains the array controller configuration information.
HP Online Configuration Utility for ProLiant Lights-Out Management Processors
The HPONCFG utility is an online configuration tool used to set up and configure iLO and RILOE II from
within the Windows and Linux operating systems 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 is not intended for continued administration. CPQLOCFG should be used for on-going
administration of user rights and network functionality on the server.
For more information, refer to the Remote Insight Lights-Out Edition II User Guide or the Integrated Lights-Out User Guide available at the Remote Management website (http://www.hp.com/servers/lights-out
Step 2: Creating a server deployment script
Although server deployment is simpler when the source server configuration mirrors that of the target
server, the Toolkit does not limit you to this condition. The data files generated by the utilities can be
edited and customized.
After the server profile data files are generated, use any ASCII text editor to edit the data files so that they
conform to the hardware available on the target servers. A full description of the options and values that
each script file accepts is given in the "Toolkit utilities (on page 8)" section.
).
For detailed examples of server batch files that launch server deployment processes, refer to the HP
SmartStart Scripting Toolkit Linux Edition Best Practices or the HP SmartStart Scripting Toolkit Win32
Edition Best Practices.
The configuration utilities and the following system utilities are used in the server deployment script. For a
description of the arguments that each utility accepts, refer to the "Toolkit utilities (on page 8)" section.
The Toolkit contains several system utilities used to control various steps in the deployment process.
Deployment overview 6
Reboot Utility
REBOOT controls server reboots during the installation process. The utility determines to which device the
server boots next and then performs the reboot. If no arguments are used, REBOOT restarts the target
server using the default boot device as defined by the system configuration settings.
State Manager Utility
STATEMGR manages persistent state information between system reboots and sets and reads a state
variable in the script file. Setting and reading the state variable enables you to control the steps necessary
to complete the configuration of the target server.
Hardware Discovery Utility
The Hardware Discovery Utility provides an inventory of the server being configured or captured.
Deployment decisions can be made based on data that is in the file created by this utility.
Hardware Query Utility
HWQUERY is a utility that reads the data in the file created by the Hardware Discovery Utility and
provides requested information in a form more easily usable in deployment decisions.
IF Hardware Utility
IFHW is a utility that makes deployment decisions based on data that is in the file created by the
Hardware Discovery Utility.
Step 3: Creating a server boot process
For detailed information about creating a server boot process to set up a Linux or Win32 installation
environment, refer to the following documents on the Tookit website
(http://www.hp.com/servers/sstoolkit
• HP SmartStart Scripting Toolkit Linux Edition Best Practices
• HP SmartStart Scripting Toolkit Win32 Edition Best Practices
):
Deployment overview 7
Toolkit utilities
In this section
Typical implementation of the utilities.......................................................................................................... 8
Utility online help ................................................................................................................................... 10
Using system utilities ............................................................................................................................... 10
Using media creation utilities................................................................................................................... 17
Using configuration utilities...................................................................................................................... 18
Typical implementation of the utilities
All the utilities that form the Toolkit combine with standard script file commands to fully configure a target
server based on a configured source server.
CAUTION: Some of the utilities in the Toolkit can destroy data if used incorrectly. Because of the potential
risk of data loss, take all necessary precautions to safeguard data so that mission-critical systems remain
online if a failure occurs.
You can use the Toolkit utilities to customize server deployment to fit your needs. The following steps
describe one example of a deployment:
1. Configure the hardware, arrays, and disk partitions on a source server using SmartStart. This
configuration is replicated to target servers by using the Toolkit utilities.
2. Generate the data files using CONREP and CPQACU.
3. Review the server profile for accuracy and potential changes for the target server.
4. Create a network share accessible by the target server.
5. Copy operating system and driver files to be installed on the target server to the network share.
Alternatively, create a CD or USB drive key with these same files.
IMPORTANT: Software is generally furnished under a license agreement and may be used or copied only
in accordance with the terms of the agreement. Before copying software to a network software repository or
creating a custom installation CD, refer to the terms of the software license agreement.
6. Store the script files and the Toolkit utilities on the network share or the user-created CD.
7. Create a bootable server process that launches the server configuration script file used to deploy the
target server, depending on the HP system ID that is detected on the target server.
8. Be sure that the server script file references the Toolkit utilities and launches the operating system
installer with appropriate command line arguments.
9. Create a server installation operating system script file by modifying the Windows UNATTEND.TXT
or the Linux kickstart or autoYaST files. For more information about creating an unattended
installation script file, refer to:
• Operating system documentation
• Microsoft® Windows® 2000 Guide to Unattended Setup
• Automated Installation with YaST2 (http://yast.suse.com/autoinstall/ref.html)
Toolkit deployment requires fewer modifications to data files when the target server hardware mirrors
the source server.
10. Boot the target server, and supervise the deployment. The procedure requires minimal interaction
from this point forward.
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[...]
Command element Meaning
SAMPLE Specifies the name of the command.
[ ]
/ or - Indicates a command line switch for executable files.
DRIVE:
PATH
FILENAME
...
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) is indented under the first line.
Indicates a component of the command line. Enter only the
information within the brackets, not the brackets
themselves.
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.
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.
Toolkit utilities 9
Utility online help
Most Toolkit utilities include usage instructions. To obtain help with the syntax, parameters, and switches
of a particular Toolkit utility, enter the file name followed by /? in the command line. For example, for
usage instructions on the CONREP utility, enter the following command:
CONREP /?
The utility displays information about its command line syntax, argument, and switches.
Using system utilities
The system utilities control steps in the installation process. System utilities in the Toolkit include:
• REBOOT
• STATEMGR
• HWDISCOVERY
• IFHW
Using REBOOT
REBOOT command line syntax
• HWQUERY
REBOOT is used from a batch file, in conjunction with other utilities, to control server reboots. This utility
enables the user to reboot the server with control over which device is the boot device. If no boot drive
argument is passed on to REBOOT, the tool reboots the server using whichever drive is specified as the
default drive.
REBOOT [DRIVE:] [/?]
REBOOT command line arguments
Command line argument Description
[DRIVE:]
/? This argument displays help information.
REBOOT return codes
REBOOT command line examples
There are no return codes for the REBOOT utility.
Command line input Result
REBOOT A: This command reboots the system to the A: drive.
REBOOT
REBOOT PXE This command reboots the system to the PXE NIC.
Valid arguments that can be passed on to REBOOT are A:, C:, CD, PXE,
or no argument. 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, the system is set to boot using the defined boot order, and the
system is restarted.
This command reboots the system to the drive that is defined as the
default boot drive in the system configuration.
Toolkit utilities 10
Using STATEMGR
STATEMGR enables the user to keep track of the execution state during system reboots. This utility saves
STATEMGR command line syntax
persistent state information across reboots of the system.
STATEMGR [/R | -R] [EVNAME] [/?]
- or -
STATEMGR command line arguments
STATEMGR [/W | -W] [EVNAME] [VALUE] [/?]
Command line input Result
/R or –R
/W or -W
EVNAME
VALUE
/? This argument displays help information.
STATEMGR return codes
The STATEMGR return codes for the Win32 and Linux editions of the Toolkit are described in the
following table.
Value Meaning
0 The command was completed successfully.
nN arguments were ignored because they were not in the variable=<string> format.
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 less.
This argument is used only with the /W or -W arguments 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 or -W, the state environment variable is cleared.
STATEMGR command line examples
Command line input Result
STATEMGR /W PHASE 3
STATEMGR writes the state value 3 to the PHASE environment
variable.
STATEMGR /R PHASE
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 the Hardware Discovery Utility
The Hardware Discovery Utility provides an inventory of the server being configured. It must be run on
each server deployed. It is executed by the server configuration script and captures the following
information:
Toolkit utilities 11
•
System ID
• System name ROM
• Processor information
• PCI devices present in the system
User process decisions can be made based on data that is in the file created by this utility.
Hardware Discovery command line syntax
The command line syntax for this utility differs for Win32 and Linux.
Win32:
hwdiscovery [drive:][path]filename [/?]
Linux:
hwdisc3 [drive:][path]-ffilename [/?]
Hardware Discovery command line arguments
Win32:
Command line input Result
[drive:][path]fil
ename
/? This argument displays help information.
Linux:
Command line input Result
[drive:][path]-ffilename
/? This argument displays help information.
This argument specifies the location and name of the Hardware
Discovery data file. If no file name is specified, the utility generates
a file in the current directory using the default name
hwdiscovery.xml.
This argument specifies the location and name of the Hardware
Discovery data file. If no file name is specified, the utility generates
a file in the current directory using the default name hwdisc-3.dat.
Hardware Discovery return codes
The Hardware Discovery return codes for the Win32 and Linux editions of the Toolkit are described in the
following tables.
Win32:
Value Meaning
0 The command was completed successfully. A usage message might be displayed.
1
2
Linux:
Value Meaning
0 The command was completed successfully. A usage message might be displayed.
1 The command contained an invalid parameter.
The Hardware Discovery Utility has detected that the ProLiant health driver is not running. The
driver might not be installed or the system is not a ProLiant server.
The command was not completed because of an error in creating or writing the file. The specified
media might not be writable.
Toolkit utilities 12
Loading...
+ 28 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.