Dell Openmanage Deployment Toolkit Version 2 4 Quick Reference Guide 2.4 Command Line Interface
2014-11-13
: Dell Dell-Openmanage-Deployment-Toolkit-Version-2-4-Quick-Reference-Guide-117722 dell-openmanage-deployment-toolkit-version-2-4-quick-reference-guide-117722 dell pdf
Open the PDF directly: View PDF
.
Page Count: 442
Dell™ OpenManage™
Deployment Toolkit Version 2.4
Command Line Interface
Reference Guide
w w w. d e l l . c o m | s u p p o r t . d e l l . c o m
Notes and Notices
NOTE: A NOTE indicates important information that helps you make better use of
your computer.
NOTICE: A NOTICE indicates either potential damage to hardware or loss of data
and tells you how to avoid the problem.
____________________
Information in this document is subject to change without notice.
© 2007 Dell Inc. All rights reserved.
Reproduction 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 PowerEdge are trademarks of
Dell Inc.; Microsoft, Windows, Windows NT, and Windows Server are registered trademarks of Microsoft
Corporation; Novell 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.; Intel,
Pentium, and EtherExpress are registered trademarks of Intel Corporation; 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.
October 2007
Contents
1
Introduction .
What’s New
. . . . . . . . . . . . . . . . . . . . . . .
9
. . . . . . . . . . . . . . . . . . . . . . . .
9
Requirements
. . . . . . . . . . . . . . . . . . . . . .
10
. . . . . . . . . . . . . . . . . . . . .
10
. . . . . . . . . . . . . . . . . . . . . .
10
Toolkit Utilities
Overview
. . . . . . . . . . . .
10
RAID Configuration Utility
. . . . . . . . . . . . .
10
RAC Configuration Utility .
. . . . . . . . . . . . .
11
. . . . . . . . . . . . . . .
11
. . . . . . . . . . . . . . . . . . . . . . .
11
System Configuration Utility
Disk Partitioning Utility
Replication
Other Dell Documents You Might Need .
Obtaining Technical Assistance
2
10
. . . . . . . . . . . . . . . .
Supported Systems .
. . . . . . . .
13
. . . . . . . . . . . .
13
Command Syntax Overview .
. . . . . . . . . .
15
. . . . . . . . . . . . . . .
15
. . . . . . . . . . . . . . . . . .
17
Command Line Syntax
Case Sensitivity
. . . . . . . . .
17
. . . . . . . . . . . .
18
Command Line Option Delimiters
Read and Write Commands
File Input and Output Commands
Log Files
. . . . . . . . .
18
. . . . . . . . . . . . . . . . . . . . . .
18
Help Option
. . . . . . . . . . . . . . . . . . . . .
Error Checking and Error Messages
. . . . . . . . . .
Contents
19
19
3
3
SYSCFG
. . . . . . . . . . . . . . . . . . . . . . . . . .
Features
. . . . . . . . . . . . . . . . . . . . . . . . .
SYSCFG General Options
. . . . . . . . . . . . . . . .
SYSCFG for BIOS Configuration
. . . . . . . . . . . . .
Options for BIOS Configuration
. . . . . . . . . .
SYSCFG for BMC and
Remote Access Controller Configuration
. . . . . . . .
BMC and Remote Access Controller
Configuration Options . . . . . . . .
SYSCFG for State Configuration .
103
103
. . . . . . . . . . .
105
. . . . . . . . .
105
114
. . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . .
Supported RAID Controllers
RAIDCFG Dependencies
117
117
117
. . . . . . . . . . . . . . . . .
118
. . . . . . . . . . . .
RAID Configuration Utility Options and
Arguments . . . . . . . . . . . . . . .
118
. . . . . . . . .
124
. . . . . . . . . . . . . . . . . . . .
124
. . . . . . . . . . .
125
. . . . . . . . . . . . . . .
127
Enumerating RAID Controllers
Creating Virtual Disks
Contents
114
. . . . . . . . . . . . . . .
RAIDCFG Options and Arguments
4
63
. . . . . .
. . . . . . . . . . . . . . . . . . . . . . . .
General Help
27
. . . . . . . . . . . . . . . . . . . .
Environment Variable File
Features
27
. . . . . . . . . . . .
Options for System Configuration
RAIDCFG
22
64
SYSCFG for System Configuration .
4
21
. . . . . . .
SYSCFG Options for State Configuration
PCI Reporting
21
Enumerating Array Disks .
. . . . . . . . . . . . .
141
Enumerating Virtual Disks
. . . . . . . . . . . . .
146
. . . . . . . . . . . . . . .
149
Deleting Virtual Disks
Assigning and Unassigning Global
Hot Spares . . . . . . . . . . . . .
. . . . . . . .
150
. . . . . . . . . . .
151
. . . . . . . . . . . . .
156
. . . . . . . . . . . . . .
157
Setting Environment Variables
RAID Replication Options
Miscellaneous Options .
Quick Reference to RAIDCFG Commands .
5
UPINIT .
. . . . . . . . . . . . . . . . . . . . . . . . .
Features
UPINIT Dependencies .
Features
163
. . . . . . . . . . .
163
. . . . . . . . . . . . . . . . .
164
UPINIT Options and Arguments
RACADM
163
. . . . . . . . . . . . . . . . . . . . . . . . .
Creating a Partition Using UPINIT
6
159
. . . . . . .
164
. . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . .
171
. . . . . . . . . . . . . . . . . . . . . . . . .
RACADM Options
. . . . . . . . . . . . . . . . . . . .
Error Messages
. . . . . . . . . . . . . . . . . .
RAC Configuration Utility Options, Subcommands,
and Arguments . . . . . . . . . . . . . . . . . . .
172
176
. .
176
. . . . . . . . . . . . . . . . .
177
. . . . . . . . . . . . . . . . . .
179
racadm Command
config/getconfig
171
. . . . . . .
181
fwupdate
. . . . . . . . . . . . . . . . . . . . . .
183
Synopsis
. . . . . . . . . . . . . . . . . . . . . .
183
getconfig Subcommand Description .
Contents
5
Description
Input
. . . . . . . . . . . . . . . . . . . . .
183
. . . . . . . . . . . . . . . . . . . . . . . .
184
Output .
. . . . . . . . . . . . . . . . . . . . . . .
Examples
. . . . . . . . . . . . . . . . . . . . . .
186
getssninfo
. . . . . . . . . . . . . . . . . . . . .
186
getsysinfo
. . . . . . . . . . . . . . . . . . . . . .
188
getraclog
. . . . . . . . . . . . . . . . . . . . . .
191
Synopsis
. . . . . . . . . . . . . . . . . . . . . .
191
. . . . . . . . . . . . . . . . . . . . .
192
. . . . . . . . . . . . . . . . . . . . . . .
192
Description
Output .
Restrictions
. . . . . . . . . . . . . . . . . . . . .
192
gettracelog
. . . . . . . . . . . . . . . . . . . . .
192
. . . . . . . . . . . . . . . . . . . . . .
193
Synopsis
. . . . . . . . . . . . . . . . . . . . .
193
. . . . . . . . . . . . . . . . . . . . . . .
193
. . . . . . . . . . . . . . . . . . . . . . . . .
193
Description
Output .
help
racdump
. . . . . . . . . . . . . . . . . . . . . .
194
racreset .
. . . . . . . . . . . . . . . . . . . . . .
194
. . . . . . . . . . . . . . . . . . . . .
196
. . . . . . . . . . . . . . . . . . . . . . . .
197
racresetcfg
setrac
A DRAC III, DRAC 4, and DRAC 5
Property Database Group and
Object Definitions . . . . . . . . . .
Contents
185
. . . . . . . . . . . . . . .
Updating the Firmware
6
185
. . . . . . .
199
DRAC III Object Groups
. . . . . . . . . . . . . . . . .
199
DRAC 4 Object Groups .
. . . . . . . . . . . . . . . . .
229
DRAC 5 Object Groups .
. . . . . . . . . . . . . . . . .
258
B Messages and Codes
. . . . . . . . . . . . . .
SYSCFG Error Codes and Messages
Failure Messages
. . . . . . . . . .
311
. . . . . . . . . . . . . . . . .
311
UPINIT Common Error Codes and Messages
Failure Messages
. . . . . .
319
. . . . . . . . . . . . . . . . .
319
UPINIT Linux-Specific Error Codes and Messages
. .
321
. . . . . . .
321
. . . . . . . . . .
321
. . . . . . . . . . . . . . . . .
321
UPINIT Windows PE-Specific Error Codes
and Messages . . . . . . . . . . . . . . .
RAIDCFG Error Codes and Messages
Failure Messages
311
RACADM Firmware Error Codes and Messages
RACADM Utility Error Codes and Messages
C BMC Platform Events Filter
Alert Messages . . . . . . . . . .
D Sample File Formats
. . . .
335
. . . . . .
337
. . . . . . . . .
341
. . . . . . . . . . . . . . .
343
Sample SYSCFG Utility .ini File Format
. . . . . . . . .
343
Sample RAIDCFG Utility .ini File Format
. . . . . . . .
359
Sample RACADM Utility .ini File Format
. . . . . . . .
360
Contents
7
E
Summary of SYSCFG and
RAIDCFG Options . . . . . .
SYSCFG Options
RAIDCFG Options
. . . . . . . . . . .
367
. . . . . . . . . . . . . . . . . . . . .
367
. . . . . . . . . . . . . . . . . . . .
391
Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
Index
8
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents
441
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® Windows® Preinstallation
Environment (Windows PE) or a Linux environment.
What’s New
Deployment Toolkit version 1.0 was the first release of a Dell-designed and
tested suite of utilities, sample script files, and best practices models to use
for configuring and deploying Dell systems in a customized, predictable, and
unattended manner. DTK versions 1.1, 1.3, and 1.4 included added support
and additional utility options. DTK version 2.0 was the first release with
flexibility to use DTK in either a Windows PE or an embedded Linux
environment.
The new features for DTK version 2.4 include:
•
Support for Dell PowerEdge systems T105, R200, R805, R900, M600, M605
NOTE: R805, M600, and M605 are scheduled to be available in Q4 CY07 - Q1
CY08.
•
Support for installing Windows PE 2.0
•
Support for PowerEdge Expandable RAID controller (PERC) 6 and Serial
Attached SCSI (SAS) 6
•
Support for Redundant Array of Independent Disks (RAID) 6 and RAID 60
•
Support for installing Microsoft Windows Server® 2008
NOTE: Microsoft Windows Server 2008 is scheduled to be available in the
first half of 2008. For the latest information, see
http://www.microsoft.com/windowsserver2008/default.mspx
Introduction
9
Requirements
For Windows PE, the DTK utilities support Windows PE version 2005 (released
with Microsoft Windows Server® 2003, Service Pack 1 [SP1]).
For embedded Linux, the DTK utilities can be run on Red Hat® Enterprise
Linux® (version 4, update 4) 32-bit.
Supported Systems
For the list of Dell systems supported for this version of DTK, see the
readme.txt file located at the root folder or the Dell Systems Software Support
Matrix on the Dell Support website at support.dell.com.
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.
10
Introduction
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.
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.
Introduction
11
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 syscfg.ini file, the SYSCFG 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 option is not available on x8xx series systems.
•
Unsupported arguments are arguments valid in SYSCFG but not
applicable on certain systems. If SYSCFG encounters an unsupported
argument, SYSCFG terminates.
For example, syscfg –-embsataraid=ahci is not applicable on
some x9xx series systems.
•
SYSCFG logs a message in the log file for each option processed in the
syscfg.ini file. To generate the log file, use the logfile option.
RAID Replication
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
Other Dell Documents You Might Need
Besides this Command Line Interface Reference Guide, you can find the
following guides on the Dell OpenManage documentation page of the Dell
Support website at support.dell.com or on the Dell Systems Documentation CD.
•
The Dell OpenManage Installation and Security User's Guide provides
additional information about performing an unattended installation of
Dell OpenManage Server Administrator on systems running supported
Windows, Red Hat Enterprise Linux, and SUSE® Linux Enterprise Server
operating systems.
•
The Dell OpenManage Server Administrator Compatibility Guide provides
compatibility information about Server Administrator installation and
operation on various hardware platforms (or systems) running supported
Windows, Red Hat Enterprise Linux, and SUSE Linux Enterprise Server
operating systems.
•
The Dell Remote Access Controller Racadm User's Guide provides
additional information about using the RACADM command line utility.
•
The Dell Update Packages User's Guide provides information about
obtaining and using Dell Update Packages as part of your system update
strategy.
Additionally, the Deployment Toolkit readme.txt file, which is available as
part of the DTK download and on the Dell Support website at
support.dell.com, provides the latest available information about the
installation and operation of the DTK components.
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.
Introduction
13
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]
OR
syscfg bmcoption1 bmcsuboption1
[arg1]...bmcsuboptionX [argX]
•
RAIDCFG
raidcfg [mandatory options]
•
RACADM
racadm
•
UPINIT
For WinPE:upinit --disk=0 --size=32 --file=
t:\upimage.bin
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]
Generic designation for a mandatory argument.
Generic designation for an optional argument.
Generic designation for a string.
Generic designation for a filename.
[]
Indicates a component of the command line. Enter only the
information within the brackets, not the brackets themselves.
...
Indicates that the previous argument can be repeated several times in
a command. Enter only the information, not the ellipsis (...) itself.
|
Separates two mutually exclusive choices in a syntax line. For
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, predefined 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 prefixed with a preceding hyphen (-).
•
Multi-character options are prefixed with two (2) preceding hyphens (--).
Example: utilname -o --option
Table 2-2 lists some examples of valid and invalid DTK command lines.
Table 2-2.
DTK Command Line Examples
Valid/
Invalid
DTK Command Line
Example
valid
syscfg --option1 -option2
syscfg --asset --floppy
invalid
syscfg --option1=argument syscfg --asset=1750 ---option2 --option3
floppy --bootseq
valid
syscfg -o=filename -option1
--option2
syscfg -o=/tmp/myfile.txt
--floppy
--bootseq
valid
syscfg -l=filename -option1
--option2
syscfg -l=
/tmp/myfile.txt --floppy
--bootseq
valid
syscfg
-i=filename
option1
--option2
valid
syscfg
--option=
argument
bmcoption
option1=argument
--
--
syscfg -i=
/tmp/myfile.txt --floppy
--bootseq
syscfg --embnic=on
pcp --hostname=webserver
NOTE: Options that specify report or set actions should not be mixed in a command
line instance.
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 command, where
is the name of the input file.
•
File output is specified by the -o command, where
is the name of the output file.
Log Files
The -l or --logfile option records
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
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 -