Dell OpenManage Deployment Toolkit Quick Reference Guide

Dell™ OpenManage™

Deployment Toolkit Version 3.1

Command Line Interface

Reference Guide

www.dell.com | support.dell.com

Notes and Cautions

NOTE: A NOTE indicates important information that helps you make better use of

your computer.

CAUTION: A CAUTION indicates potential damage to hardware or loss of data if

instructions are not followed.

____________________

Reproduction of these materials in any manner whatsoever without the written permission of Dell Inc. is strictly forbidden.

Trademarks used in this text: Dell, the DELL logo, OpenManage, and Pow e rE dg e are trademarks of Dell Inc.; Microsoft, Windows, Windows NT, Vis ta , and Windows Server are registered trademarks of Microsoft Corporation in the United States and/or other countries; Novell, NetWare, and SUSE are registered trademarks of Novell, Inc. in the United States and other countries; Red Hat and Red Hat

Enterprise Linux are registered trademarks of Red Hat, Inc. in the United States and/or other countries; Intel, Pentium, and EtherExpress are registered trademarks of Intel Corporation in the United States

and/or other countries; AMD, AMD Opteron, AMD-V, and AMD PowerNow! are trademarks of Advanced Micro Devices, Inc. in the United States and/or other countries; UNIX is a registered trademark of The Open Group in the United States and other countries.

Other trademarks and trade names may be used in this document to refer to either the entities claiming the marks and names or their products. Dell Inc. disclaims any proprietary interest in trademarks and trade names other than its own.

April 2009

Contents

1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . 9

What’s New in This Release . . . . . . . . . . . . . . . 9

Requirements

Toolkit Utilities

Overview

System Configuration Utility

RAID Configuration Utility

RAC Configuration Utility

Disk Partitioning Utility

Replication

Introduction

Dell™ OpenManage™ Deployment Toolkit (DTK) includes a set of utilities for configuring and deploying Dell PowerEdge™ systems. DTK is designed for customers who need to build scripted installations in order to deploy large numbers of systems in a reliable fashion without having to dramatically change their current deployment processes.

DTK consists of command line utilities to configure various system features, sample scripts to perform common deployment tasks, and documentation for each utility. You can use DTK in a Microsoft Environment (Windows PE) or a Linux environment.

What’s New in This Release

This release of DTK includes support for:

• New SYSCFG options for BIOS configuration

• New RAIDCFG options

• Support for new Dell PowerEdge systems

• Support for the PERC 6/i Integrated RAID controller for modular systems

NOTE: For the list of PowerEdge systems supported for this version of DTK,

see the readme.txt file in the root folder, or the Dell Systems Software Support Matrix on the Dell Systems Management Tools and Documentation DVD or on the Dell Support website at support.dell.com.

Windows® Preinstallation

Requirements

For Windows PE, the DTK utilities support Windows PE version 2005 (created using 32-bit version of Microsoft Windows Server and Windows PE 2.0 (created using 32-bit version built on the Windows

Vista

kernel).

NOTE: DTK utilities do not support Windows PE created with any 64-bit version of

Microsoft Windows Server 2003.

For embedded Linux, the DTK utilities can be run on Red Hat® Enterprise

Linux

(version 4, update 4) 32-bit.

2003, Service Pack 1 [SP1])

Introduction 9

Toolkit Utilities

Overview

DTK contains utilities that allow you to configure the BIOS, baseboard management controller (BMC), remote access controller (RAC), RAID controllers, and hard-drive partitions on supported Dell systems. Additionally, the utilities can be integrated with the sample files provided with the toolkit to fully configure one-to-many target systems in a scripted mass system deployment.

NOTE: In a Linux environment, the DTK utilities do not have a .exe extension.

System Configuration Utility

The SYSCFG utility performs the following tasks:

• Reports and sets BIOS configuration options

• Reports and sets BMC/RAC configuration options

• Reports and sets user-configurable states

• Reports system information, including PCI device detection

RAID Configuration Utility

The RAIDCFG utility reports and sets RAID configuration options.

RAC Configuration Utility

The RACADM utility reports and sets RAC configuration options for Dell Remote Access Controller (DRAC) III (Linux only) and DRAC 4.

NOTE: DRAC 5 is configured by SYSCFG.

Disk Partitioning Utility

The UPINIT script creates, formats, and populates a Dell Utility Partition.

10 Introduction

Replication

File Format

The -i and -o options use a .ini file format for SYSCFG options. All name/value entries that follow the [syscfg] section header in the .ini file belong to the SYSCFG utility. For an example of the syscfg.ini file, see "Sample SYSCFG Utility .ini File Format."

SYSCFG Replication Rules

Not all BIOS and BMC options can be replicated using a .ini file. For example, boot sequence and device sequence are only replicated if a device name list can be supplied. A numerical device list cannot be replicated since these index values can change from system to system. In addition, because the service tag information is static, it is not commented out in the output file or replicated. See the description of each option for further replication information.

The syscfg.ini file cannot be used across different systems. The file output operation places system identification information at the beginning of the [syscfg] section. This information is used to determine if the file can be accepted as input for a system. The following information is used for system identification:

• System ID Byte(s)

•System Name

• BIOS Version

If these values do not match the values found on the system, the file input operation fails.

The following is the SYSCFG behavior during replication:

• Options not available in SYSCFG are termed invalid options. If SYSCFG encounters an invalid option in the utility terminates.

• Unsupported options are options available in SYSCFG but not applicable on certain systems. If SYSCFG encounters an unsupported option, SYSCFG logs this option and continues to the next option.

For example, the

virtualization

syscfg.ini

option is not available on x8xx series systems.

file, the SYSCFG

Introduction 11

• Unsupported arguments are arguments valid in SYSCFG but not applicable on certain systems. If SYSCFG encounters an unsupported argument, SYSCFG terminates.

For exa m pl e,

x9xx

some

syscfg –-embsataraid=ahci

series systems.

is not applicable on

• SYSCFG logs a message in the log file for each option processed in the

syscfg.ini

RAID Replication

file. To generate the log file, use the

logfile

option.

The RAID replication feature reads the RAID configuration information from the source system and creates a raid.ini file. This raid.ini file can be applied on the RAID configurations of the target system. The RAID replication requires both, the source system and the target system to have similar RAID controllers.

RACADM Replication

The RACREP.BAT sample script applies RAC configuration options to the target system based on the configuration information that has been saved in a configuration file. User input is optional, depending on variables set in the RACREP.BAT sample script. This script uses the RACADM.EXE utility to configure the RAC in the target system using the RAC configuration file, raccfg.ini. The raccfg.ini configuration file is passed as the first parameter to the RACREP.BAT script. If this parameter is not passed, the default variable values used in this script are set in the TKENVSET.BAT scripts. An optional second parameter can be passed to this file, which specifies the IP address used in configuring the RAC. The raccfg.ini file is generated with the RACCAP.BAT sample script.

12 Introduction

Obtaining Technical Assistance

If at any time you do not understand a procedure described in this guide or if your product does not perform as expected, help tools are available to assist you. For more information about these help tools, see "Getting Help" in your system's Hardware Owner's Manual.

Additionally, Dell Enterprise Training and Certification is available; see www.dell.com/training for more information. This service may not be offered in all locations.

14 Introduction

Command Syntax Overview

Syntax refers to the way a command and its parameters are entered. Dell™ OpenManage™ Deployment Toolkit (DTK) Command Line Interface (CLI) commands can be arranged in any order in a command line instance as long as they conform to the basic command line syntax.

Command Line Syntax

The general usage models of the DTK utilities are as follows:

•SYSCFG

syscfg option1 [arg1] ... optionX [argX]

syscfg bmcoption1 bmcsuboption1

[arg1]...bmcsuboption

• RAIDCFG

raidcfg [mandatory options] <optional arguments>

•RACADM

racadm <

•UPINIT

For WinPE:upinit --disk=0 --size=32 --file= t:\upimage.bin

options

> <

[argX]

subcommand

> <

subcommand_options

For Linux:upinit --disk=/dev/sda --size=32 --file= /tmp/upimage.bin

The DTK command line switches, configuration file formatting, and error reporting follow similar style and behavior. However, individual DTK utilities can sometimes differ from one another in significant ways. You should familiarize yourself with the command line syntax and utility-specific options and arguments for each utility before using DTK.

NOTE: Some of the command line options in DTK are followed by an asterisk.

Such options are used for reporting purposes only.

Command Syntax Overview 15

Table 2-1 lists the generic command line characters and arguments present in the command line options with a short description of these characters.

Table 2-1. Command Line Syntax

Element Description

- Single-character options are prefixed with a preceding hyphen (-).

NOTE: This delimiter is not applicable to Baseboard Management

Controller (BMC) suboptions.

-- Multi-character options are prefixed with two (2) preceding hyphens (--).

utilname Generic designation for a DTK utility name.

o Generic single-character designation for an option.

optionX Generic multi-character designation for a utility name, where X can

be used to distinguish multiple options used in the same command line instance.

argX Generic designation for an argument, where X can be used to distinguish

multiple arguments used in the same command line instance.

[mandatory option]

<string> Generic designation for a string.

<filename> Generic designation for a filename.

[ ] Indicates a component of the command line. Enter only the

... Indicates that the previous argument can be repeated several times in

| Separates two mutually exclusive choices in a syntax line. For

Generic designation for a mandatory argument.

Generic designation for an optional argument.

information within the brackets, not the brackets themselves.

a command. Enter only the information, not the ellipsis (...) itself.

example:

usb: Turns the usb controller on or off.

Argument: enable | disable | legacy

Enter only one choice: --usb=enable, --usb=disable, or

--usb=legacy

16 Command Syntax Overview

Case Sensitivity

• Command line options, pre-defined and user-defined arguments, and filenames given as arguments are all case sensitive.

• Unless specified otherwise, enter all commands, options, arguments, and command line switches in lowercase letters.

Command Line Option Delimiters

• Single-character options are

• Multi-character options are

Example: utilname -o --option

Table 2-2 lists some examples of valid and invalid DTK command lines.

Table 2-2. DTK Command Line Examples

prefixed

with a preceding hyphen (-).

with two (2) preceding hyphens (--).

Valid/ Invalid

valid syscfg --option1 --option2 syscfg --asset --floppy

invalid syscfg --option1=argument

valid syscfg -o=filename

valid syscfg -l=filename

valid syscfg -i=filename

valid syscfg --option=argument

DTK Command Line Example

syscfg --asset=1750

--option2 --option3

--option1

--option2

--option1

--option2

--option1

--option2

bmcoption

--option1=argument

NOTE: Options that specify report or set actions should not be mixed in a command

line instance.

--floppy --bootseq

syscfg -o=/tmp/myfile.txt

--floppy

--bootseq

syscfg -l= /tmp/myfile.txt --floppy

--bootseq

syscfg -i= /tmp/myfile.txt --floppy

--bootseq

syscfg --embnic=on pcp --hostname=webserver

Command Syntax Overview 17

NOTE: Example 2 is invalid because the report and set actions are used in the

same command line.

NOTE: Examples 3, 4, and 5 are valid because the aliases use neither report nor

set actions.

Read and Write Commands

Options can report a certain value or set of values based on the presence of an argument. These read or write actions are implied in the DTK command line arguments. The get, read, set, or write commands, for example, are not required.

NOTE: Options that specify read or write actions should not be mixed in a

command line instance.

Table 2-3. Read and Write Command Examples

Valid/Invalid DTK Command Line Example

valid syscfg --option1 --option2

valid syscfg --option1=arg --option2=arg

invalid syscfg --option1=arg --option2

File Input and Output Commands

• File input is specified by the -i < where <

filename

> is the name of the input file.

• File output is specified by the where <

filename

> is the name of the output file.

filename

-o

> command,

filename

> command,

Log Files

The -l < information output on the command line to the specified log file. Each new line of output is preceded by a time stamp.

If the log file already exists, information is appended to the file. This allows multiple tools to use the same log file to record information. This option should be used instead of redirection to record a utility’s output since time data can assist with task diagnosis.

18 Command Syntax Overview

filename

> or --logfile <

filename

> option records

The log duplicates all standard output and error information to the specified file. Each log file begins with a time stamp and utility name. For example,

YYYY/MM/DD HH:MM:SS <utilname

The following is an example of the logging behavior:

2003/11/28 10:23:17 syscfg -

> - <

option1

output text

=on

2003/11/28 10:23:17 syscfg -

NOTE: The log files may contain sensitive information such as passwords and

authentication information. To protect such information, it is recommended that only the administrator access the log files.

option2

option3

=on

=off

Help Option

The -h and --help options display general usage information for the utility. If the argument matches a valid option, that option's usage information is displayed. If the option has arguments, the arguments are displayed, separated by a | character. If the argument does not match a valid option, a usage error is given (and usage information is displayed). This option cannot be replicated.

Error Checking and Error Messages

The DTK utilities check your commands for correct syntax when you enter them. When a command is executed successfully, a message displays stating that your command has been successful. Unrecognized or invalid options and arguments result in a usage error that displays the DTK utility name and version along with a short message. For information about the error messages, see "Messages and Codes."

Command Syntax Overview 19

20 Command Syntax Overview

SYSCFG

This section documents the Deployment Toolkit (DTK) system configuration utility. It describes the command line parameters, configuration file format, and individual executables used to configure server BIOS and baseboard management controller (BMC) settings, DTK state settings, and system information including PCI device detection.

Features

The SYSCFG utility has the following general features:

• Displays help and usage information

• Outputs configuration options to a file or screen

• Reads configuration options from a file or CLI parameters

• Configures BMC/remote access controller (RAC) users, local area network (LAN) channel and serial channel settings, BMC/RAC platform event filter (PEF) settings, and BMC/RAC serial-over-LAN (SOL) settings

• Configures the nonmaskable interrupt (NMI) and power button

• Reports the BMC/RAC firmware version, BMC/RAC device global unique identifier (GUID), and BMC/RAC LAN channel and serial channel information

• Reports BMC/RAC session information

• Clears BMC/RAC system event log (SEL)

• Restores BMC/RAC factory defaults

• Records and reports the state data value

• Displays system configuration information

• Returns specific error codes and messages

• Logs activity to a given filename

• Configures the BIOS features

NOTE: In Microsoft® Windows® Preinstallation Environment (Windows PE),

the SYSCFG utility is located at \dell\toolkit\tools. In Linux, you can find it in /opt/dell/toolkit/bin.

SYSCFG 21

SYSCFG General Options

NOTE: Some of the options in SYSCFG are followed by an asterisk. These commands

do not accept any suboptions or arguments. The values associated with these commands are those that are reported by the BIOS. These values cannot be modified.

Table 3-1 lists the SYSCFG general options.

Table 3-1. SYSCFG General Options

Options Suboptions Valid

Arguments

No option NA NA If an option is not given, the SYSCFG utility

Description

outputs usage information. The usage information is displayed in the format shown below.

Example:

A:>syscfg

syscfg version 1.X.123 A06

Usage: syscfg --option[=argument] or

syscfg --option [argument] or

syscfg option --suboption [=suboptionargument]

For more information about a particular command, use the option '-h' followed by the command name.

Example: syscfg -h bmcversion.

Options without preceding delimiters have suboptions.

Example: syscfg lancfgparams

Options with preceding delimiters do not have suboptions.

Example: syscfg --powerbutton

option1 option4 option7

option2 option5 option8

option3 option6 option9

22 SYSCFG

Table 3-1. SYSCFG General Options (continued)

Options Suboptions Valid

Arguments

--envar valid filename

valid path

media should be writable

Description

When used with the –s option, this option stores the environment variable data to a file. This file can be called from other scripts to set the environment variable. The value of <filename> need not be specified if the DTKENVSCR environment variable is set to a valid filename. In this case, the filename pointed to by DTKENVSCR is used to store the environment variable data.

Example:

syscfg --mem -s=temp --envar= z:\scripts\file.bat

When used without the -s option, --envar takes the default variable.

Linux Example:

syscfg --svctag --envar= /tmp/myvars.txt

svctag = 2G8LC1S

syscfg_var = ’2G8LC1S’

source /tmp/myvars.txt

Windows PE Example:

syscfg --svctag --envar= i:\myvars.bat

svctag = 2G8LC1S

syscfg_var = ’2G8LC1S’

call i:\myvars.bat

SYSCFG 23

Table 3-1. SYSCFG General Options (continued)

Options Suboptions Valid

Arguments

-h or

--help

NA none

<valid

option name>

Description

Without an argument, this option displays general usage information for the utility. If the argument matches a valid option, that option's usage information is displayed. If the option has arguments, the arguments are displayed, separated by a | character. If the option has suboptions, all suboptions, valid arguments, and a description are listed. If the argument does not match a valid option, a usage error is given (and usage information is displayed). This option cannot be replicated.

Example:

A:>syscfg -h lanchannelaccess

lanchannelaccess: Reports LAN channel access information.

Suboptions:

pefalerting: Enable or disable PEF (Platform Event Filter) alerting.

Arguments: enable | disable

ipmioverlan: Enable or disable IPMI over LAN access.

Arguments: disable | alwaysavail

channelprivlmt: Sets the maximum privilege level that can be accepted on the LAN channel.

Arguments: user | operator | administrator

24 SYSCFG

Table 3-1. SYSCFG General Options (continued)

Options Suboptions Valid

Arguments

-i

--infile

-l

--logfile

NA <filename> This option directs the SYSCFG utility to take

NA <filename> This option logs the command line output to a

Description

input from a .ini file. The utility searches the file for a section heading identical to the utility name. An error is returned if the file or section is not found. If the section is found, each name/value pair is applied to the system. The names must match a valid option, and the arguments must be in the proper format for the option. If an option is not available on a system and it is specified in a file, the utility ignores the option. If any errors are found in the format of the names or values, an error is returned and the options are not applied to the system. If this option is used with other function command options, they are applied in the order in which they appear on the command line, overriding any previous commands. This option can be replicated.

Example:

A:>syscfg -i

time-stamped file. The utility either appends the information to an existing log file or creates a new file. The log file contains the same information as the standard output, plus timestamp information. Users should use this option instead of redirection for task diagnosis. This option can be replicated. See "Log Files" for more information.

Example:

A:>syscfg -l

filename

logfile

.ini

SYSCFG 25

Table 3-1. SYSCFG General Options (continued)

Options Suboptions Valid

Arguments

-o or

--outfile

-s NA <string> This option prints the variable name and the

--version* This option displays the version information,

NA <filename> This option prints all replicable options to the

Description

specified filename. The format of the output is in a .ini format, with the utility name as the section header. If a file with the same name already exists, the information is appended to the file. If this option is used with other function commands, the commands are applied in the order in which they appear. This option captures replicable BMC and BIOS options.

Example:

A:>syscfg -o

value assigned to it to the console. This option when used with --envar, picks up the environment variable data and stores it in a file. This file can be called from a script. See "--envar" for more information.

Example:

A:>syscfg -s ENVNAME --svctag

svctag=SERVICE

ENVNAME=SERVICE

current time, and date for the utility. This option cannot be replicated.

Example:

A:>syscfg --version

syscfg version 1.X.XX AXX

filename.ini

NOTE: The asterisk is not part of the command

syntax.

26 SYSCFG

SYSCFG for BIOS Configuration

SYSCFG uses BIOS interfaces to manipulate boot order and BIOS settings. It configures all options available on the BIOS setup screen, including boot order, embedded device configuration, and asset tag management.

Options for BIOS Configuration

Table 3-2 documents valid options and arguments along with a description of their expected behavior. Options and arguments are case sensitive. All options and pre-defined arguments are lowercase unless stated otherwise.

NOTE: Some of the following options or arguments might not be available on all

systems due to the BIOS version or hardware feature set. Running SYSCFG without arguments displays only those options that are valid for your system.

Table 3-2. SYSCFG Options and Arguments for BIOS Configuration

Option Valid Arguments Description Applicable

Systems

--acpower on, off, last This option sets the behavior for

the system after AC power is lost. This option specifies how the system responds to the restoration of AC power and is particularly useful in systems that are turned off using a power strip. When set to on, the system turns on after AC is restored. When set to off, the system does not turn on after AC is restored. When set to last, the system turns on if the system was on when AC power was lost; if the system was off when AC power was lost, the system remains off when power is restored. This option is available on all supported systems. This value can be replicated.

Example:

A:>syscfg --acpower=on

acpower=on

All Dell PowerEdge systems

SYSCFG 27

Table 3-2. SYSCFG Options and Arguments for BIOS Configuration (continued)

Option Valid Arguments Description Applicable

Systems

-adjcacheprefetch

--asset <string> This option reports or sets the

enable, disable When this option is set to enabled,

the processor fetches the cache line containing the currently requested data, and the adjacent cache line.

When this option is set to disabled, the processor fetches only the cache line containing the currently requested data.

Example:

A:>syscfg -adjcacheprefetch=enable

adjcacheprefetch=disable

customer-programmable asset tag number for a system. The maximum length of an asset tag is 10 characters. Asset tag values cannot contain any spaces. This option is available on all supported systems. This value can be replicated.

Example:

A:>syscfg --asset=

All Dell PowerEdge systems

ASSETTAG

asset=

ASSETTAG

28 SYSCFG

Table 3-2. SYSCFG Options and Arguments for BIOS Configuration (continued)

Option Valid Arguments Description Applicable

Systems

--assignintr standard,

distributed

--bezelir enable, disable This option enables or disables the

--bootmode uefi, bios This option enables booting to

This option controls the interrupt assignment of PCI devices in the system. This option is set to standard by default, causing standard interrupt routing that uses interrupt A, B, C, and D for all PCIe devices. When set to distributed, the interrupt routing is swizzled at the MCH root ports to minimize sharing of interrupts across all PCIe (and PCI-X in the Programmable Interrupt Controller (PIC) mode) devices.

Example:

A:>syscfg --assignintr= standard

assignintr=standard

ESM to monitor and log front bezel intrusion conditions.

Example:

A:>syscfg --bezelir= enable

bezelir=enable

Unified Extensible Firmware Interface (UEFI) -capable operating systems or ensures compatibility with operating systems that do not support UEFI.

Example:

A:>syscfg --bootmode= uefi

bootmode=uefi

All Dell PowerEdge systems

Dell PowerEdge xx1x systems

SYSCFG 29

Table 3-2. SYSCFG Options and Arguments for BIOS Configuration (continued)

Option Valid Arguments Description Applicable

Systems

--bootseq numerical list, separated by commas

list of device names, separated by commas

This option sets the boot order for a system. Without an argument, this option prints the boot order list. The argument must be formatted as a comma-separated numerical list with no spaces. The list must be within the bounds of the current boot list, i.e. the low and high numbers must match, and the same number of entries must be supplied. This option is available on all supported systems. Systems that use a numerical list for boot order cannot be replicated.

Some systems also allow the boot order to be expressed as a list of device names. Device names are formatted as a name.location.instance string, where name is the name of the device, location is either slot or embedded (emb), and instance is the numerical position of the device. Some device name examples are shown below. Systems that support a list of device names for boot order can be replicated.

All Dell PowerEdge systems

30 SYSCFG

+ 336 hidden pages

Dell OpenManage Deployment Toolkit Quick Reference Guide

Specifications and Main Features

Frequently Asked Questions

User Manual

Introduction

What’s New in This Release

Requirements

Toolkit Utilities

Overview

System Configuration Utility

RAID Configuration Utility

RAC Configuration Utility

Disk Partitioning Utility

Replication

Other Dell Documents You Might Need

Obtaining Technical Assistance

Command Syntax Overview

Command Line Syntax

Case Sensitivity

Command Line Option Delimiters

Read and Write Commands

File Input and Output Commands

Log Files

Help Option

Error Checking and Error Messages

SYSCFG

Features

SYSCFG General Options

SYSCFG for BIOS Configuration

Options for BIOS Configuration