Dell Openmanage Deployment Toolkit Version 3 4 Quick Reference Guide 3.4 Command Line Interface
2014-11-13
: Dell Dell-Openmanage-Deployment-Toolkit-Version-3-4-Quick-Reference-Guide-117751 dell-openmanage-deployment-toolkit-version-3-4-quick-reference-guide-117751 dell pdf
Open the PDF directly: View PDF
.
Page Count: 296
Dell OpenManage
Deployment Toolkit 3.4
Command Line Interface
Reference Guide
FILE LOCATION: C:\Work\DTK\DTK_CLI_3.4\Source\DTKCLtp.fm
D E L L C O N F I D E N T I A L – P R E L I M I N A R Y 1 2 / 3 / 1 0 – F O R P R O O F O N LY
Template Last Updated -03/06/2010
FILE LOCATION: C:\Work\DTK\DTK_CLI_3.4\Source\DTKCLtp.fm
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.
____________________
Information in this publication is subject to change without notice.
© 2010 Dell Inc. All rights reserved.
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, PowerEdge™, and OpenManage™ are
trademarks of Dell Inc. Intel® and Core™ and are registered trademarks of Intel Corporation in the
U.S. and other countries. AMD Opteron™ is a trademark of Advanced Micro Devices, Inc. Microsoft®
and Windows® are either trademarks or registered trademarks of Microsoft Corporation in the United
States and/or other countries. Red Hat Enterprise Linux® and Enterprise Linux® are registered
trademarks of Red Hat, Inc. in the United States and/or other countries. SUSE ™ is a trademark of
Novell Inc. in the United States and other countries. Adaptec is a registered trademark of Adaptec, Inc.
Other trademarks and trade names may be used in this publication 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.
November 2010
FILE LOCATION: C:\Work\DTK\DTK_CLI_3.4\Source\bookTOC.fm
Contents
1
Introduction .
What’s New
. . . . . . . . . . . . . . . . . . . . . . .
7
. . . . . . . . . . . . . . . . . . . . . . . .
7
Requirements
. . . . . . . . . . . . . . . . . . . . . . .
7
. . . . . . . . . . . . . . . . . . . . . .
7
Toolkit Utilities
. . . . . . . . . . . . .
8
RAID Configuration Utility
. . . . . . . . . . . . . .
8
RAC Configuration Utility .
. . . . . . . . . . . . . .
8
Disk Partitioning Utility
. . . . . . . . . . . . . . . .
8
Replication of DTK Utilities
. . . . . . . . . . . . . . . .
8
System Configuration Utility
2
Other Documents You May Need
. . . . . . . . . . . .
10
Obtaining Technical Assistance
. . . . . . . . . . . .
11
Command Syntax Overview .
. . . . . . . . . .
13
. . . . . . . . . . . . . . .
13
. . . . . . . . . . . . . . . . . .
15
Command Line Syntax
Case Sensitivity
Command Line Option Delimiters
Read and Write Commands
. . . . . . . . .
15
. . . . . . . . . . . .
16
File Input and Output Commands
Log Files
. . . . . . . . .
16
. . . . . . . . . . . . . . . . . . . . . .
17
Help Option
. . . . . . . . . . . . . . . . . . . . .
Error Checking and Error Messages
. . . . . . . . . .
Contents
17
17
3
FILE LOCATION: C:\Work\DTK\DTK_CLI_3.4\Source\bookTOC.fm
3
SYSCFG
. . . . . . . . . . . . . . . . . . . . . . . . . .
Features
. . . . . . . . . . . . . . . . . . . . . . . . .
SYSCFG General Options
. . . . . . . . . . . . . . . .
SYSCFG for BIOS Configuration
. . . . . . . . . . . . .
Options for BIOS Configuration
. . . . . . . . . .
SYSCFG for BMC and Remote Access Controller
Configuration . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . .
128
. . . . . .
128
. . . . . . . . . . .
130
. . . . . . . . .
130
. . . . . . . . . . . . .
140
. . . . . . . . . . . . . . . . . . . . . .
141
SYSCFG for IPv6 Configuration
Environment Variable File
Features
. . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . .
RAIDCFG Dependencies
143
. . . . . . . . . . . . . . . . .
144
. . . . . . . . . . . .
RAID Configuration Utility Options and Arguments .
144
. .
151
. . . . . . . . . . . . . . . . . . . .
152
Enumerating RAID Controllers
Contents
143
143
RAIDCFG Options and Arguments
General Help
142
. . . . . . . . . . . . . . .
Supported RAID Controllers
4
25
88
Options for System Configuration
RAIDCFG
25
. . . . . . .
SYSCFG for System Configuration .
4
20
87
SYSCFG Options for State Configuration
PCI Reporting
19
. . .
BMC and Remote Access Controller
Configuration Options . . . . . . . .
SYSCFG for State Configuration .
19
. . . . . . . . . . .
153
FILE LOCATION: C:\Work\DTK\DTK_CLI_3.4\Source\bookTOC.fm
Creating Virtual Disks
. . . . . . . . . . . . .
168
Enumerating Virtual Disks
. . . . . . . . . . . . .
174
. . . . . . . . . . . . . .
177
Initializing Virtual Disks
Importing and Clearing Foreign
Configurations . . . . . . . . .
Deleting Virtual Disks
. . . . . . . . . .
178
. . . . . . . . . . . . . . .
180
Assigning and Unassigning
Global Hot Spares . . . . .
Setting Environment Variables
. . . . . .
181
. . . . . . . . . . .
183
Function Calls of Setenvironment Option
. . . . .
184
. . . . . . . . . . . . .
187
. . . . . . . . . . . . . .
189
RAID Replication Options
Miscellaneous Options .
Quick Reference to RAIDCFG Commands .
UPINIT .
191
. . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . .
Features
181
. . . . . . . . . . . .
Assigning and Unassigning Persistent
Dedicated Hot Spares . . . . . . . . .
5
155
. . . . . . . . . . . . . . .
Enumerating Array Disks .
195
195
. . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . .
195
. . . . . . . . . . . . . . . . .
196
Creating a Partition Using UPINIT
UPINIT Dependencies .
UPINIT Options and Arguments
A Messages and Codes
. . . . . . . . . . . . . .
SYSCFG Error Codes and Messages
Failure Messages
203
. . . . . . . . . .
203
. . . . . . . . . . . . . . . . .
203
UPINIT Common Error Codes and Messages
Failure Messages
196
. . . . . . . . . . . . .
. . . . . .
213
. . . . . . . . . . . . . . . . .
214
Contents
5
FILE LOCATION: C:\Work\DTK\DTK_CLI_3.4\Source\bookTOC.fm
UPINIT Linux-Specific Error Codes and Messages .
. .
215
. . . . . . .
215
. . . . . . . . . .
215
. . . . . . . . . . . . . . . . .
215
UPINIT Windows PE-Specific Error Codes
and Messages . . . . . . . . . . . . . . .
RAIDCFG Error Codes and Messages
Failure Messages
RACADM Firmware Error Codes and Messages
RACADM Utility Error Codes and Messages
B BMC Platform Events Filter
Alert Messages . . . . . . . . .
C Sample File Formats
. . . . . .
231
235
. . . . . . . . . . . . . . .
237
. . . . . . . . .
237
Sample RAIDCFG Utility .ini File Format
. . . . . . . .
253
Sample RACADM Utility .ini File Format
. . . . . . . .
254
D Summary of SYSCFG and
RAIDCFG Options . . . . . .
SYSCFG Options
RAIDCFG Options
6
229
. . . . . . . . . .
Sample SYSCFG Utility .ini File Format
Index
. . . .
. . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . .
261
. . . . . . . . . . . . . . . . . . . .
290
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents
261
295
1
Introduction
Dell OpenManage Deployment Toolkit (DTK) includes a set of utilities for
configuring and deploying Dell PowerEdge systems. You can use DTK to
build script-based and RPM-based installation for deploying large number of
systems in a reliable way, without changing 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
DTK CLI does not have any updates for this release.
Requirements
For Windows PE, the DTK utilities support Windows PE 2.0 (32-bit and 64-bit)
and Windows PE 3.0 (32-bit and 64-bit).
For embedded Linux, the DTK utilities can be run on Red Hat Enterprise
Linux (version 4, update 4) 32-bit.
Toolkit Utilities
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 the .exe extension.
D E L L C O N F I D E N T I A L – P R E L I M I N A R Y 1 2 / 3 / 1 0 - F O R P R O O F O N LY
Template Last Updated - 2/7/2007
Introduction
7
FILE LOCATION: C:\Work\DTK\DTK_CLI_3.4\Source\DTKCLc01.fm
System Configuration Utility
The System Configuration (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) 4, DRAC 5, and iDRAC 6.
Disk Partitioning Utility
The UPINIT script creates, formats, and populates a Dell Utility Partition.
Replication of DTK Utilities
File Format
The -i and -o options use the .ini file format for system configuration
(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" on page 237.
SYSCFG Replication Rules
Not all BIOS and BMC options can be replicated using the .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.
D E L L C O N F I D E N T I A L – P R E L I M I N A R Y 1 2 / 3 / 1 0 - F O R P R O O F O N LY
8
Introduction
FILE LOCATION: C:\Work\DTK\DTK_CLI_3.4\Source\DTKCLc01.fm
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 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 Dell PowerEdge
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, the command syscfg –-embsataraid=ahci is not
applicable on some Dell PowerEdge 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 to the RAID configurations of the target system. The RAID
replication requires both, the source system and the target system to have
similar RAID controllers.
D E L L C O N F I D E N T I A L – P R E L I M I N A R Y 1 2 / 3 / 1 0 - F O R P R O O F O N LY
Introduction
9
FILE LOCATION: C:\Work\DTK\DTK_CLI_3.4\Source\DTKCLc01.fm
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.
Other Documents You May Need
In addition to this guide, you can access the following guides available at
support.dell.com/manuals. On the Manuals page, click Software Systems
Management. Click on the appropriate product link on the right-side to
access the documents.
•
The Dell OpenManage Deployment Toolkit User's Guide provides best
practice procedures that focus on the basic tasks for successful deployment
of Dell systems.
•
The Dell Systems Software Support Matrix provides information about the
various Dell systems, the operating systems supported by these systems,
and the Dell OpenManage components that can be installed on
these systems.
•
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 User's Guide provides
information on using Server Administrator on supported operating
systems.
•
The Dell Update Packages User's Guide provides information about
obtaining and using Dell Update Packages as part of your system
update strategy.
D E L L C O N F I D E N T I A L – P R E L I M I N A R Y 1 2 / 3 / 1 0 - F O R P R O O F O N LY
10
Introduction
FILE LOCATION: C:\Work\DTK\DTK_CLI_3.4\Source\DTKCLc01.fm
•
For more information on RAID controllers, see Dell OpenManage Sever
Adminstrator Storage Management User’s Guide on the Dell support site.
•
The Command Line Reference Guide for iDRAC6 and CMC provides
information about the RACADM subcommands, supported interfaces,
property database groups and object definitions for iDRAC6 and CMC.
•
The Integrated Dell Remote Access Controller 6 (iDRAC6) Enterprise for
Blade Servers User Guide provides information about configuring and
using an iDRAC6 for blade servers to remotely manage and monitor your
system and its shared resources through a network.
•
The Integrated Dell Remote Access Controller 6 (iDRAC6) User Guide
provides complete information about configuring and using an iDRAC6
for rack and tower servers to remotely manage and monitor your system
and its shared resources through a network.
•
The Glossary provides information about the terms used in this document.
Additionally, the Deployment Toolkit readme.txt file, which is available as
part of the DTK download at support.dell.com/manuals, provides the latest
available information about the installation and operation of the DTK
components and the list of PowerEdge systems supported for this version of
DTK.
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.
D E L L C O N F I D E N T I A L – P R E L I M I N A R Y 1 2 / 3 / 1 0 - F O R P R O O F O N LY
Introduction
11
FILE LOCATION: C:\Work\DTK\DTK_CLI_3.4\Source\DTKCLc01.fm
D E L L C O N F I D E N T I A L – P R E L I M I N A R Y 1 2 / 3 / 1 0 - F O R P R O O F O N LY
12
Introduction
Command Syntax Overview
2
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
NOTE: The Command Line Reference Guide for iDRAC6 and CMC available on
support.dell.com provides information about the RACADM subcommands,
supported interfaces, property database groups and object definitions for
iDRAC6 and CMC.
•
UPINIT
For WinPE:upinit --disk=0 --size=32 --file=
t:\upimage.bin
For Linux:upinit --disk=/dev/sda --size=32 --file=
/tmp/upimage.bin
D E L L C O N F I D E N T I A L – P R E L I M I N A R Y 1 2 / 3 / 1 0 - F O R P R O O F O N LY
Template Last Updated - 2/7/2007
Command Syntax Overview
13
FILE LOCATION: C:\Work\DTK\DTK_CLI_3.4\Source\DTKCLc02.fm
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.
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
-
Prefix single character options with a single hyphen (-).
NOTE: This delimiter is not applicable to Baseboard Management
Controller (BMC) sub-options.
--
Prefix multi-character options with two hyphens (--).
utilname
Indicates the generic designation for a DTK utility name.
o
Indicates the generic single-character designation for an option.
optionX
Indicates the generic multi-character designation for a utility name,
where you can use X to distinguish multiple options used in the same
command line instance.
argX
Indicates the generic designation for an argument, where you can use X
to distinguish multiple arguments used in the same command line
instance.
[mandatory
option]
Indicates the generic designation for a mandatory argument.
Indicates the generic designation for an optional argument.
Indicates the generic designation for a string.
Indicates the generic designation for a filename.
[]
Indicates a component of the command line. Enter only the
information within the brackets and exclude the brackets.
D E L L C O N F I D E N T I A L – P R E L I M I N A R Y 1 2 / 3 / 1 0 - F O R P R O O F O N LY
14
Command Syntax Overview
FILE LOCATION: C:\Work\DTK\DTK_CLI_3.4\Source\DTKCLc02.fm
Table 2-1. Command Line Syntax (continued)
Element
Description
...
Indicates that the previous argument can be repeated several times in
a command. Enter only the information within the ellipses and
exclude the ellipses.
|
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.
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
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=R910
--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
D E L L C O N F I D E N T I A L – P R E L I M I N A R Y 1 2 / 3 / 1 0 - F O R P R O O F O N LY
Command Syntax Overview
15
FILE LOCATION: C:\Work\DTK\DTK_CLI_3.4\Source\DTKCLc02.fm
Table 2-2. DTK Command Line Examples
Valid/
Invalid
DTK Command Line
Example
valid
syscfg
-i=filename
--option1
--option2
syscfg -i=
/tmp/myfile.txt --floppy
--bootseq
valid
syscfg --option=argument
bmcoption
--option1=argument
syscfg --embnic=on
pcp --hostname=webserver
NOTE: Do not combine options that specify report or set actions in a command line
instance.
NOTE: If you use report and set actions are in the same command line, the
command is invalid.
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: You cannot combine options that specify read or write actions 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
•
Specify the file input using the -i command,
where is the name of the input file.
•
Specify the file output using the -o command,
where is the name of the output file.
D E L L C O N F I D E N T I A L – P R E L I M I N A R Y 1 2 / 3 / 1 0 - F O R P R O O F O N LY
16
Command Syntax Overview
FILE LOCATION: C:\Work\DTK\DTK_CLI_3.4\Source\DTKCLc02.fm
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. Use the -l
option to record the output of a utility.
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 -