Dell OpenManage Deployment Toolkit Version 5.1 Reference guide

Type
Reference guide
Dell OpenManage Deployment Toolkit
Version 5.1
Command Line Interface Reference Guide
Notes, cautions, and warnings
NOTE: A NOTE indicates important information that helps you make better use of your computer.
CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you
how to avoid the problem.
WARNING: A WARNING indicates a potential for property damage, personal injury, or death.
Copyright © 2015 Dell Inc. All rights reserved. This product is protected by U.S. and international copyright and
intellectual property laws. Dell
â„¢
and the Dell logo are trademarks of Dell Inc. in the United States and/or other
jurisdictions. All other marks and names mentioned herein may be trademarks of their respective companies.
2015 - 04
Rev. A00
Contents
1 Introduction...........................................................................................................8
What's New In This Release.................................................................................................................. 8
Supported Systems................................................................................................................................9
Supported operating systems............................................................................................................... 9
Toolkit Utilities.......................................................................................................................................9
System Configuration Utility......................................................................................................... 10
RAID Configuration Utility.............................................................................................................10
RAC Configuration Utility..............................................................................................................10
Disk Partitioning Utility.................................................................................................................. 10
Replication Of DTK Utilities.................................................................................................................10
File Format..................................................................................................................................... 10
SYSCFG Replication Rules.............................................................................................................10
RAID Replication.............................................................................................................................11
RACADM Replication......................................................................................................................11
Other Documents You May Need.......................................................................................................11
Accessing documents from Dell Support Site....................................................................................12
Contacting Dell....................................................................................................................................12
2 Command Syntax Overview............................................................................. 14
DTK Utilities General Usage................................................................................................................ 14
Command Line Syntax........................................................................................................................ 15
Case Sensitivity.................................................................................................................................... 15
Command Line Option Delimiters......................................................................................................16
Other Delimiters.................................................................................................................................. 16
Read And Write Commands................................................................................................................17
File Input And Output Commands......................................................................................................17
Log Files............................................................................................................................................... 18
Help Option......................................................................................................................................... 18
Error Checking And Error Messages...................................................................................................18
3 SYSCFG................................................................................................................. 19
Features................................................................................................................................................19
SYSCFG General Options.................................................................................................................... 19
No Option......................................................................................................................................20
--envar...........................................................................................................................................20
-h or --help...................................................................................................................................20
-i or --infile.................................................................................................................................... 21
--ix or --inxmlfile...........................................................................................................................21
3
-l or --logfile..................................................................................................................................22
-o or --outfile................................................................................................................................22
--ox or --outxmlfile...................................................................................................................... 22
--ovrwrt*....................................................................................................................................... 23
--px or --pendingxmlfile.............................................................................................................. 23
-s.................................................................................................................................................... 23
--version*...................................................................................................................................... 23
SYSCFG For BIOS Configuration........................................................................................................ 24
BIOS Option Settings.....................................................................................................................41
Boot Settings................................................................................................................................. 44
Integrated Devices........................................................................................................................ 46
Network Settings...........................................................................................................................54
Memory Settings........................................................................................................................... 56
Miscellaneous Settings..................................................................................................................60
One-Time Boot............................................................................................................................. 63
Processor Settings.........................................................................................................................65
SATA Settings.................................................................................................................................76
Serial Communication.................................................................................................................. 88
Slot Disablement...........................................................................................................................90
System Information....................................................................................................................... 91
System Profile Settings..................................................................................................................93
System Security.............................................................................................................................98
UEFI Boot Settings.......................................................................................................................107
SYSCFG Options On PowerEdge Systems Prior To PowerEdge 12G Systems.........................107
Sub Options And Arguments For power Option.............................................................................. 113
Sub Options And Arguments For tcm Option.................................................................................. 115
Sub Options And Arguments For tpm Option..................................................................................116
SYSCFG For BMC And Remote Access Controller Configuration...................................................118
bmcversion.................................................................................................................................. 118
chassistype*................................................................................................................................. 119
clearsel*........................................................................................................................................119
controlpanelaccess......................................................................................................................119
deviceguid*.................................................................................................................................. 119
encryptkey................................................................................................................................... 120
--fiberchannel............................................................................................................................. 120
--floppy....................................................................................................................................... 120
--formfactor.................................................................................................................................121
--hddfailover................................................................................................................................121
--hpcmode.................................................................................................................................. 121
--htassist......................................................................................................................................122
--idecdrom..................................................................................................................................122
--idracgui.....................................................................................................................................122
4
--lpt..............................................................................................................................................122
--memdynamicpower.................................................................................................................123
--memintleave.............................................................................................................................123
--memremap...............................................................................................................................123
--mouse.......................................................................................................................................124
--noraidprompt*......................................................................................................................... 124
--oldsetuppwd............................................................................................................................ 124
--oldsyspwd.................................................................................................................................125
--opticaldrivectrl......................................................................................................................... 125
--remflashmedia......................................................................................................................... 126
--serial1........................................................................................................................................126
--serial2........................................................................................................................................127
--slotname...................................................................................................................................127
--sma........................................................................................................................................... 127
--sysrev*...................................................................................................................................... 127
--usb............................................................................................................................................128
--usbflash.................................................................................................................................... 128
--vflash........................................................................................................................................ 128
identify......................................................................................................................................... 128
idracversion................................................................................................................................. 129
kvmstatusonlcd........................................................................................................................... 129
lancfgparams...............................................................................................................................130
lanchannelaccess........................................................................................................................ 133
lanchannelinfo.............................................................................................................................134
lanuseraccess.............................................................................................................................. 134
lcd1...............................................................................................................................................135
lcd2...............................................................................................................................................135
loaddefaults*................................................................................................................................135
nextboot.......................................................................................................................................135
nmibutton.................................................................................................................................... 136
passwordaction........................................................................................................................... 136
pefcfgparams............................................................................................................................... 137
powerbutton................................................................................................................................139
powerctl.......................................................................................................................................139
racreset*...................................................................................................................................... 140
serialcfgparams........................................................................................................................... 140
serialchannelaccess.....................................................................................................................141
serialchannelinfo......................................................................................................................... 142
serialuseraccess...........................................................................................................................142
solaction...................................................................................................................................... 143
solcfgparams............................................................................................................................... 144
ssninfo..........................................................................................................................................145
5
useraction....................................................................................................................................146
username.....................................................................................................................................146
version*........................................................................................................................................147
virutualmedia............................................................................................................................... 147
SYSCFG For State Configuration.......................................................................................................147
SYSCFG Options For State Configuration.................................................................................. 147
SYSCFG for System Configuration................................................................................................... 148
Options For System Configuration.............................................................................................148
SYSCFG For IPv6 Configuration........................................................................................................153
PCI Reporting.................................................................................................................................... 154
Environment Variable File............................................................................................................155
4 RAIDCFG.............................................................................................................156
Features............................................................................................................................................. 156
Supported RAID Controllers............................................................................................................. 156
RAIDCFG Options And Arguments................................................................................................... 157
RAID Configuration Utility Options And Arguments........................................................................165
General Help................................................................................................................................166
Enumerating RAID Controllers................................................................................................... 166
Creating Virtual Disks.................................................................................................................. 167
Enumerating Array Disks............................................................................................................. 175
Blinking And Unblinking Array Disks........................................................................................... 178
Enumerating Virtual Disks........................................................................................................... 178
Deleting Virtual Disks.................................................................................................................. 180
Increasing Virtual Disk Size..........................................................................................................181
Setting A Virtual Disk As Bootable Virtual Disk........................................................................... 181
Blinking And Unblinking Virtual Disks......................................................................................... 181
Setting Virtual Disk Name............................................................................................................182
Setting Environment Variables....................................................................................................182
RAID Replication Options............................................................................................................185
Assigning, Unassigning, And Listing Global Hot Spares.............................................................186
Importing And Clearing Foreign Configurations........................................................................187
Importing Secured Foreign Configuration.................................................................................189
Displaying Foreign Key Ids.......................................................................................................... 189
Creating Encryption Key............................................................................................................. 189
Changing Encryption Key........................................................................................................... 190
Deleting Encryption Key............................................................................................................. 190
Configuring Physical Disk Rebuild.............................................................................................. 191
Configuring Array Disk As RAID ................................................................................................. 192
Configuring Physical Disk State.................................................................................................. 192
Replacing Physical Disk Of A Virtual Disk...................................................................................193
Consistency Check For Virtual Disk............................................................................................194
6
Erasing Encrypted Physical Disk................................................................................................. 194
Discarding Preserved Cache.......................................................................................................195
Initializing Virtual Disks................................................................................................................196
Resetting The Controller.............................................................................................................196
Enabling And Disabling Persistent Dedicated Hot Spares......................................................... 197
Setting And Displaying The PCIe Link Speed..............................................................................197
Setting Boot Mode ..................................................................................................................... 198
Configuring Auto Import ............................................................................................................199
Miscellaneous Options................................................................................................................199
Quick Reference To RAIDCFG Commands.....................................................................................200
5 UPINIT................................................................................................................ 203
Features.............................................................................................................................................203
Creating A Partition Using UPINIT................................................................................................... 203
UPINIT Dependencies...................................................................................................................... 203
UPINIT Options And Arguments...................................................................................................... 204
6 Messages And Codes.......................................................................................208
SYSCFG Error Codes And Messages................................................................................................208
Failure Messages.........................................................................................................................208
Failures And Solutions................................................................................................................. 216
UPINIT Common Error Codes And Messages..................................................................................217
Failure Messages..........................................................................................................................217
UPINIT Linux-Specific Error Codes And Messages..........................................................................218
UPINIT Windows PE-Specific Error Codes And Messages..............................................................218
RAIDCFG Error Codes And Messages.............................................................................................. 218
Failure Messages..........................................................................................................................218
RACADM Firmware Error Codes And Messages..............................................................................230
RACADM Utility Error Codes And Messages....................................................................................232
7 BMC Platform Events Filter Alert Messages.................................................235
8 Sample File Formats.........................................................................................237
Sample SYSCFG Utility .ini File Format............................................................................................. 237
Sample RAIDCFG Utility .ini File Format...........................................................................................245
Sample RACADM Utility .ini File Format...........................................................................................246
7
1
Introduction
Dell OpenManage Deployment Toolkit (DTK) includes a set of utilities, sample scripts, and sample
configuration files to deploy and configure your Dell system. You can use DTK to build script-based and
RPM-based installation for deploying a large number of systems reliably, without changing their current
deployment processes. You can use DTK in a Microsoft Windows Preinstallation Environment (Windows
PE) or a Linux environment.
What's New In This Release
NOTE: Dell OpenManage Deployment Toolkit version 5.1 is supported on Dell’s 10th to 13th
generation of PowerEdge servers.
The new features for this release include:
• Availability of DTK boot-critical drivers as cabinet (CAB) file. For more details, see the Dell
OpenManage Deployment Toolkit User’s Guide.
• Added support for the following Dell PERC 9 controllers:
– FD33xD
– FD33xS
• Support for the following Dell PowerEdge systems:
– FC830
– M830
– FC430
– C4130
– FD332
NOTE: For more information about the deployment and configuration of Dell PowerEdge
FD332, see the Dell OpenManage Deployment Toolkit User’s Guide.
• Added support for Red Hat Enterprise Linux 7.0 operating system on Dell’s 11th generation and later
PowerEdge servers.
• Support for the following network cards:
– Emulex OCm14104-N1-D QP 4x10Gb rNDC Ethernet Network Adapter
– Emulex OCm14102-N6-D DP 10Gb bNDC Ethernet Network Adapter
– Emulex OCm14102-N1-D Dual-port 10Gb PCIe Ethernet Network Adapter
– Emulex OCm14102-N5-D DP 10Gb bMezz Ethernet Network Adapter
– Intel X710 QP 10Gb KR 4x10Gb Network Daughter Card
– Intel I350/X710 2x10Gb BT 2x10Gb SFP+ Network Daughter Card
– Intel X710 4x10GE SFP+/DA FH PCIe Ethernet Network Adapter
8
– Intel X710 2x10GE SFP+/DA FH PCIe Ethernet Network Adapter
• Support for installation and deployment of SUSE Linux Enterprise Server 12 (64-bit) in BIOS and UEFI
mode.
NOTE: For the list of supported operating systems and Dell servers, see the Dell Systems Software
Support Matrix at dell.com/openmanagemanuals.
Supported Systems
For a complete list of supported Dell PowerEdge systems, see the Dell Systems Software Support Matrix
in the required version of OpenManage Software at dell.com/openmanagemanuals
Supported operating systems
DTK utilities support Windows PE 5.1 (64-bit), Windows PE 4.0 (64-bit), and Windows PE 3.0 (64-bit) to
deploy the following operating systems in BIOS and UEFI mode:
• Microsoft Windows Server 2008 SP2 (32-bit and 64-bit)
NOTE: On Dell's 13th generation and later PowerEdge servers, deployment of Microsoft
Windows Server 2008 SP2 (32-bit and 64-bit) is not supported.
• Microsoft Windows Server 2008 R2 SP1( 64-bit)
• Microsoft Windows Server 2012 Foundation, Essentials, Standard, and Datacenter editions
• Microsoft Windows Server 2012 R2 Foundation, Essentials, Standard, and Datacenter editions
For Linux, the DTK utilities support deploying the following operating systems in BIOS and UEFI mode:
• SUSE Linux Enterprise Server 12 (64-bit)
• SUSE Linux Enterprise Server 11 SP3 (64-bit)
• Red Hat Enterprise Linux 7.0 (64-bit)
• Red Hat Enterprise Linux 6.5 (64-bit)
You can install the DTK Linux RPM utilities on the following operating systems in BIOS and UEFI mode:
• SUSE Linux Enterprise Server 12 (64-bit)
• SUSE Linux Enterprise Server 11 SP3 (64-bit)
• Red Hat Enterprise Linux 7.0 (64-bit)
• Red Hat Enterprise Linux 6.5 (64-bit)
NOTE: The RPMs are available in the RPMs folder of DTK ELI ISO at linux.dell.com/repo/hardware,
and also in the
Dell Systems Management Tools and Documentation DVD.
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.
9
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
5, iDRAC6, and iDRAC7, and iDRAC8.
Disk Partitioning Utility
The UPINIT script creates, formats, and populates a Dell Utility Partition.
Replication Of DTK Utilities
This section explains the 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.
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 the 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.
10
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.
• Unsupported arguments are arguments valid in SYSCFG but not applicable on certain systems. If
SYSCFG encounters an unsupported argument, SYSCFG terminates.
• 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.
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 dell.com/support/manuals.
• The Dell OpenManage Deployment Toolkit Installation Guide provides information about installing
and deploying DTK on supported Dell systems. The guide is also available as part of the DTK
download.
• 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 Guide provides additional information about performing an
unattended installation of Dell OpenManage Server Administrator on systems running supported
Windows, Red Hat Enterprise Linux, and Citrix Xen 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.
• The Dell OpenManage Sever Administrator Storage Management User’s Guide provides information
about RAID controllers.
11
• The Integrated Dell Remote Access Controller 8 (iDRAC8) Command Line Interface Reference Guide
provides information about the RACADM subcommands, supported interfaces, property database
groups and object definitions for iDRAC8 and CMC.
• The Integrated Dell Remote Access Controller 8 (iDRAC8) User's Guide provides information about
configuring and using iDRAC8 for 13
th
generation rack, tower, and blade 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.
• The Deployment Toolkit release notes (for Windows PE and embedded Linux) which is also available
as part of the DTK download, 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.
Accessing documents from Dell Support Site
You can access the required documents in one of the following ways:
• Using the following links:
– For all Enterprise Systems Management documents — dell.com/softwaresecuritymanuals
– For OpenManage documents — dell.com/openmanagemanuals
– For Remote Enterprise Systems Management documents — dell.com/esmmanuals
– For OpenManage Connections Enterprise Systems Management documents — dell.com/
OMConnectionsEnterpriseSystemsManagement
– For Serviceability Tools documents — dell.com/serviceabilitytools
– For Client Systems Management documents — dell.com/clientsystemsmanagement
– For OpenManage Connections Client Systems Management documents — dell.com/
dellclientcommandsuitemanuals
• From the Dell Support site:
a. Go to dell.com/support/home.
b. Under Select a product section, click Software & Security.
c. In the Software & Security group box, click the required link from the following:
– Enterprise Systems Management
– Remote Enterprise Systems Management
– Serviceability Tools
– Client Systems Management
– Connections Client Systems Management
d. To view a document, click the required product version.
• Using search engines:
– Type the name and version of the document in the search box.
Contacting Dell
NOTE: If you do not have an active Internet connection, you can find contact information on your
purchase invoice, packing slip, bill, or Dell product catalog.
12
Dell provides several online and telephone-based support and service options. Availability varies by
country and product, and some services may not be available in your area. To contact Dell for sales,
technical support, or customer service issues:
1. Visit support.dell.com .
2. Select your support category.
3. If you are not a U.S customer, select your country code at the bottom of the page, or select All to
see more choices.
4. Select the appropriate service or support link based on your need.
13
2
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 as long as they
conform to the basic command line syntax.
DTK Utilities General Usage
The following table lists the general usage models of the DTK utilities:
Table 1. DTK Utilities
Utilities Usage
SYSCFG
syscfg --option1=[arg1] ... --optionX=[argX]
or
syscfg bmcoption1 --bmcsuboption1=[arg1]...--
bmcsuboptionX=argX]
RAIDCFG
raidcfg [mandatory options] <optional arguments>
RACADM
racadm <options> <subcommand> <subcommand_options>
NOTE: The Command Line Reference Guide for iDRAC6 and
CMC available on dell.com/support/manuals 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
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 must 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.
14
Command Line Syntax
The following table lists the generic command line characters and arguments present in the command
line options with a short description of these characters.
Table 2. Command Line Options
Element Description
-
Prefix single character options.
NOTE: This delimiter is not applicable to Baseboard
Management Controller (BMC) sub-options.
--
Prefix multi-character options.
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.
<optional argument>
Indicates the generic designation for an optional argument.
<string>
Indicates the generic designation for a string.
<filename>
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.
...
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 on PowerEdge systems prior to PowerEdge 12G systems.
15
• Unless specified otherwise, enter all commands, options, arguments, and command line switches in
lowercase letters.
Command Line Option Delimiters
The following table lists some examples of valid and invalid DTK command lines.
Table 3. Command Line Option Delimiters
Valid /
Invalid
DTK Command Line Example
valid
syscfg --option1 --option2 syscfg --asset --floppy
invalid
syscfg --option1=argument --
option2 --option3
syscfg --asset=R910 --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
invalid
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.
Other Delimiters
The following table lists the other delimiters:
Table 4. Other delimiters
Delimiter Example Description
White space (space or tab)
syscfg --
option=argument1
argument2
considers
argument1
and
argument2
as two arguments.
A string surrounded by double
quotation marks regardless of
the white space contained
within, is interpreted as a single
SYSCFG argument.
syscfg --
option="argument1
argument2"
considers
argument1
and
argument2
a single argument.
16
Delimiter Example Description
A double quotation mark
preceded by a backslash (\") is
interpreted as a literal double
quotation mark (").
syscfg --
option="\"argument"
considers "argument as the
argument.
Backslashes are interpreted
literally, unless they immediately
precede a double quotation
mark. If an even number of
backslashes are followed by a
double quotation mark, then one
backslash (\) is taken for every
pair of backslashes (\\), and the
double quotation mark (") is
interpreted as a string delimiter.
syscfg --option="\
\"argument"
considers \ and argument as two
arguments.
If an odd number of backslashes
are followed by a double
quotation mark, then one
backslash (\) is taken for every
pair of backslashes (\\) and the
double quotation mark is
interpreted as an escape
sequence by the remaining
backslash, causing a literal
double quotation mark (") to be
placed in the SYSCFG argument.
syscfg --option="\\
\"argument"
considers \ "argument as the
argument.
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 5. 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 <filename> command, where <filename> is the name of the
input file.
• Specify the file output using the -o <filename> command, where <filename> is the name of the
output file.
17
Log Files
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 < utilname > - <output text> .
The following is an example of the logging behavior:
2003/11/28 10:23:17 syscfg - option1=on
2003/11/28 10:23:17 syscfg - option2=on
2003/11/28 10:23:17 syscfg - option3 =off
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 accesses
the log files.
Help Option
The -h and --help options display general usage information for the utility. If the argument matches a
valid option, that usage information of the option 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.
18
3
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:
• Displays help and usage information.
• Outputs configuration options to a file or screen.
• Reads configuration options from a file or Command Line Interface (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 using ini file, DTK xml file, and ws-man xml file.
NOTE: In Microsoft Windows Preinstallation Environment (Windows PE), the SYSCFG utility is
located at \dell\toolkit\tools or \dell\toolkit\tools directory. In Linux, you can find it in the/opt/dell/
toolkit/bin directory.
SYSCFG General Options
NOTE: Some of the options in SYSCFG are followed by an asterisk. The asterisk is not part of the
command syntax. Such options are used for reporting purposes only. These commands do not
accept any sub-options or arguments. The values associated with these commands are reported by
the BIOS. You cannot modify these values.
19
No Option
Valid Arguments NA
Description The SYSCFG utility displays the usage information.
--envar
Valid Arguments <valid filename> <valid path>
Description Stores the environment variable data to a file when used with the – s
option. This file can be called from other scripts to set the
environment variable. The value of <filename> must 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
-h or --help
Valid Arguments none or <valid option name>
Description Displays the general usage information for the utility, when no
argument is provided. 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 sub-options, all sub-options, 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.
20
  • Page 1 1
  • Page 2 2
  • Page 3 3
  • Page 4 4
  • Page 5 5
  • Page 6 6
  • Page 7 7
  • Page 8 8
  • Page 9 9
  • Page 10 10
  • Page 11 11
  • Page 12 12
  • Page 13 13
  • Page 14 14
  • Page 15 15
  • Page 16 16
  • Page 17 17
  • Page 18 18
  • Page 19 19
  • Page 20 20
  • Page 21 21
  • Page 22 22
  • Page 23 23
  • Page 24 24
  • Page 25 25
  • Page 26 26
  • Page 27 27
  • Page 28 28
  • Page 29 29
  • Page 30 30
  • Page 31 31
  • Page 32 32
  • Page 33 33
  • Page 34 34
  • Page 35 35
  • Page 36 36
  • Page 37 37
  • Page 38 38
  • Page 39 39
  • Page 40 40
  • Page 41 41
  • Page 42 42
  • Page 43 43
  • Page 44 44
  • Page 45 45
  • Page 46 46
  • Page 47 47
  • Page 48 48
  • Page 49 49
  • Page 50 50
  • Page 51 51
  • Page 52 52
  • Page 53 53
  • Page 54 54
  • Page 55 55
  • Page 56 56
  • Page 57 57
  • Page 58 58
  • Page 59 59
  • Page 60 60
  • Page 61 61
  • Page 62 62
  • Page 63 63
  • Page 64 64
  • Page 65 65
  • Page 66 66
  • Page 67 67
  • Page 68 68
  • Page 69 69
  • Page 70 70
  • Page 71 71
  • Page 72 72
  • Page 73 73
  • Page 74 74
  • Page 75 75
  • Page 76 76
  • Page 77 77
  • Page 78 78
  • Page 79 79
  • Page 80 80
  • Page 81 81
  • Page 82 82
  • Page 83 83
  • Page 84 84
  • Page 85 85
  • Page 86 86
  • Page 87 87
  • Page 88 88
  • Page 89 89
  • Page 90 90
  • Page 91 91
  • Page 92 92
  • Page 93 93
  • Page 94 94
  • Page 95 95
  • Page 96 96
  • Page 97 97
  • Page 98 98
  • Page 99 99
  • Page 100 100
  • Page 101 101
  • Page 102 102
  • Page 103 103
  • Page 104 104
  • Page 105 105
  • Page 106 106
  • Page 107 107
  • Page 108 108
  • Page 109 109
  • Page 110 110
  • Page 111 111
  • Page 112 112
  • Page 113 113
  • Page 114 114
  • Page 115 115
  • Page 116 116
  • Page 117 117
  • Page 118 118
  • Page 119 119
  • Page 120 120
  • Page 121 121
  • Page 122 122
  • Page 123 123
  • Page 124 124
  • Page 125 125
  • Page 126 126
  • Page 127 127
  • Page 128 128
  • Page 129 129
  • Page 130 130
  • Page 131 131
  • Page 132 132
  • Page 133 133
  • Page 134 134
  • Page 135 135
  • Page 136 136
  • Page 137 137
  • Page 138 138
  • Page 139 139
  • Page 140 140
  • Page 141 141
  • Page 142 142
  • Page 143 143
  • Page 144 144
  • Page 145 145
  • Page 146 146
  • Page 147 147
  • Page 148 148
  • Page 149 149
  • Page 150 150
  • Page 151 151
  • Page 152 152
  • Page 153 153
  • Page 154 154
  • Page 155 155
  • Page 156 156
  • Page 157 157
  • Page 158 158
  • Page 159 159
  • Page 160 160
  • Page 161 161
  • Page 162 162
  • Page 163 163
  • Page 164 164
  • Page 165 165
  • Page 166 166
  • Page 167 167
  • Page 168 168
  • Page 169 169
  • Page 170 170
  • Page 171 171
  • Page 172 172
  • Page 173 173
  • Page 174 174
  • Page 175 175
  • Page 176 176
  • Page 177 177
  • Page 178 178
  • Page 179 179
  • Page 180 180
  • Page 181 181
  • Page 182 182
  • Page 183 183
  • Page 184 184
  • Page 185 185
  • Page 186 186
  • Page 187 187
  • Page 188 188
  • Page 189 189
  • Page 190 190
  • Page 191 191
  • Page 192 192
  • Page 193 193
  • Page 194 194
  • Page 195 195
  • Page 196 196
  • Page 197 197
  • Page 198 198
  • Page 199 199
  • Page 200 200
  • Page 201 201
  • Page 202 202
  • Page 203 203
  • Page 204 204
  • Page 205 205
  • Page 206 206
  • Page 207 207
  • Page 208 208
  • Page 209 209
  • Page 210 210
  • Page 211 211
  • Page 212 212
  • Page 213 213
  • Page 214 214
  • Page 215 215
  • Page 216 216
  • Page 217 217
  • Page 218 218
  • Page 219 219
  • Page 220 220
  • Page 221 221
  • Page 222 222
  • Page 223 223
  • Page 224 224
  • Page 225 225
  • Page 226 226
  • Page 227 227
  • Page 228 228
  • Page 229 229
  • Page 230 230
  • Page 231 231
  • Page 232 232
  • Page 233 233
  • Page 234 234
  • Page 235 235
  • Page 236 236
  • Page 237 237
  • Page 238 238
  • Page 239 239
  • Page 240 240
  • Page 241 241
  • Page 242 242
  • Page 243 243
  • Page 244 244
  • Page 245 245
  • Page 246 246
  • Page 247 247
  • Page 248 248

Dell OpenManage Deployment Toolkit Version 5.1 Reference guide

Type
Reference guide

Ask a question and I''ll find the answer in the document

Finding information in a document is now easier with AI