The RACADM utility provides a scriptable interface that allows you to locally
or remotely configure your remote access controller (RAC).
Using the RACADM utility, you can enter command line options to configure RAC
properties. When you enter command line options, the RACADM utility sets or
retrieves object property values in the RAC properties database.
You can also use the RACADM utility to write scripts that will automatically
configure multiple RACs. For example, when configuring in batch mode, a series
of calls to the RACADM utility can perform actions such as upgrading RAC
firmware, setting a property to a specific value, and reading the configuration
of the RAC. All command switches are case sensitive. For more information about
configuring multiple RACs, see "RAC Configuration File" in the Dell Remote
Access Controller Racadm User's Guide.
CAUTION: Commands and code samples in this section are
RAC-specific. Some commands or samples may not be applicable to your RAC.
Also, the -r option for performing racadm commands remotely is not
available for the RACADM utility.
NOTE: In Microsoft�
Windows� Preinstallation Environment (Windows PE), you can find the RACADM
utility in \DELL\TOOLKIT\TOOLS. In Linux, you can find it in
/opt/dell/toolkit/bin. The RAC service must be started before issuing racadm
commands. In Linux systems, the RAC service is started by the racsvc3.sh
(for DRAC III, DRAC III/XT, ERA, ERA/O, and ERA/MC RACs) or the racsvc4.sh
(for DRAC 4/P and DRAC 4/I RACs) script located at /opt/dell/toolkit/bin.
In Windows systems, the RAC service is called racsvc and is located at
\DELL\DRIVERS\RAC 4.
Features
The RAC configuration utility has the following general features:
Displays help and usage information.
Configures RAC information.
Saves RAC
configuration information to a configuration file.
NOTE: Ensure that you run this option from a
writable folder.
-L<filename>
NA
Specifies the location for the debug log
file.
-p<password>
NA
Specifies the password used to
authenticate the command transaction. If the -p option is used,
the -i option is not allowed.
-u<username>
NA
Specifies the user name that is used to
authenticate the command transaction. If not specified, the default user
name racadmusr is used. If the -u option is used, the -p
option must be used, and the -i option (interactive) is not allowed.
-v<integer>
NA
Specifies the verbose level for screen
output. See "Log/Verbose Levels."
NA
clearasrscreen
Clears the last automatic server restart
(ASR) (crash) screen.
NA
clrraclog
Clears the RAC log.
NA
clrsel
Clears RAC system event log (SEL).
NA
config
Configures the RAC. See "config/getconfig"
for more information about the subcommand options and arguments.
NA
coredump
Displays the last RAC coredump.
NA
coredumpdelete
Deletes the last RAC coredump.
NA
fwupdate
Updates the firmware on the RAC. See "fwupdate"
for more information about the subcommand options and arguments.
NA
getconfig
Gets the RAC configuration data. See "config/getconfig"
for more information about the subcommand options and arguments.
NA
getniccfg
Displays the current network settings.
NA
getssninfo
Retrieves session information for one or
more currently active or pending sessions from the Session Manager's session
table. See "getssninfo" for more
information about the subcommand options and arguments.
NA
getraclog
Displays the RAC log. See "getraclog"
for more information about the subcommand options and arguments.
NA
getractime
Displays the current RAC time.
NA
getsel
Displays records from the SEL.
NA
getssninfo
Displays the session information. See "getssninfo"
for more information about the subcommand options and arguments.
NA
getsvctag
Displays the service tag information.
NA
getsysinfo
Retrieves session information for one or
more currently active or pending sessions from the Session Manager's session
table. See "getsysinfo" for more
information about the subcommand options and arguments.
NA
gettracelog
Displays the RAC diagnostic trace log. See
"gettracelog" for more information
about the subcommand options and arguments.
NA
help
Lists all of the subcommands available to
use with the RACADM utility and provides a short description for each. See "getraclog"
for more information about the subcommand options and arguments.
NA
localauthenticate
Enables or disables the local operating
system authentication.
NA
localConRedirDisable
Performs local vKVM disable from local
system.
NA
racdump
Displays status and general RAC
information. See "racdump" for more
information about the subcommand options and arguments.
NA
racreset
Resets the RAC. See "racreset"
for more information about the subcommand options and arguments.
NA
racresetcfg
Resets all database configuration
parameters to default values; equivalent to a soft reset. See "racresetcfg"
for more information about the subcommand options and arguments.
NA
setrac
Sets RAC parameters from the managed
system. See "setrac" for more
information about the subcommand options and arguments.
NA
serveraction
Performs system power management
operations.
NA
setniccfg
Modifies the network configuration
properties.
NA
sslcertupload
Uploads an SSL (Secure Socket Layer)
certificate to the RAC.
NA
sslcertdownload
Downloads an SSL certificate from the RAC.
NA
sslcertview
Displays the SSL certificate information.
NA
sslcsrgen
Generates a certificate CSR (certificate
signing request) from the RAC.
NA
sslkeyupload
Uploads an SSL key to the RAC.
NA
testemail
Tests RAC e-mail notifications.
NA
testtrap
Tests RAC SNMP trap notifications.
NA
version
Displays the RACADM version information.
NA
vmdisconnect
Disconnects virtual media connections.
NA
vmkey
Performs virtual media key operations.
NA
usercertupload
Uploads a user certificate to the DRAC.
NA
usecertview
Displays the user certificate information.
Error Messages
When using RACADM utility commands and subcommands, you may encounter one or
more of the following errors:
Local error messages occur when problems occur
with syntax, typographical errors, incorrect names, and so on.
Example:
racadm <subcmd> :
ERROR : <message>
Transport error messages occur when the RACADM
utility communication paths to the RAC are not accessible.
Example:
racadm <subcmd> :
Transport : ERROR : <message>
RAC firmware errors occur when a fault exists in
the RAC firmware operation.
Example:
racadm <subcmd> :
Firmware : ERROR : <message>
RAC Configuration Utility
Options, Subcommands, and Arguments
The following sections document all valid options, subcommands, and arguments
along with a description of the expected behavior of many
option-subcommand-argument combinations. Options, subcommands, and arguments are
case sensitive. All options, subcommands, and pre-defined arguments are
lowercase unless explicitly stated otherwise.
NOTE: Some of the
following options or arguments might not be available on all systems.
racadm Command
Table 6-2. racadm
Command Help Option
Command
Definition
racadm
Command line status and configuration
utility for RACs.
Description
Without options, the RACADM utility executes the help command, which
displays a list of available tests and a one-line description of each. The
RACADM utility help <subcommand>
displays any syntax and command line options.
The argument 0x3 for the log level is the OR of STDOUT and STDERR messages.
Both of these message types are written to the filename log. The verbose,
or -v, option defaults to 0x3, or STDOUT, STDERR.
NOTE: Option -f
excludes the use of the g, o, and i options.
racadm getconfig [-p] -f <filename>
racadm getconfig -g <groupName> [-i <index>]
racadm getconfig -u <username>
racadm getconfig -h
config Subcommand Description
The configuration subcommand allows the user to set RAC configuration
parameters individually or to batch them as part of a configuration file. After
the .cfg file has been correctly parsed, each object is read. If the
content is the same, a write to the RAC does not occur. If the data is
different, that RAC object is written with the new value.
Input
Table 6-7. config
Subcommand Options
Option
Description
-f
The -f <filename>
option causes config to read the contents of the file specified by
<filename> and configure the RAC. The file must contain data in the
format specified in "Parsing Rules."
-p
The -p, or password option, directs
config to delete the password entries contained in the config file
-f <filename>
after the configuration is complete.
-g
The -g <groupName>,
or group option, must be used with the -o option. The <groupName>
specifies the group containing the object that is to be set.
-o
The -o <objectName>
<Value>,
or object option, must be used with the -g option. This option
specifies the object name that is written with the string<Value>.
-i
The -i <index>,
or index option, is only valid for indexed groups and can be used to specify
a unique group. The <index> is a decimal integer from 1–16. The index
is specified here by the index value, not a named value.
-c
The -c, or check option, is used
with the config subcommand and allows the user to parse the .cfg
file to find syntax errors. If errors are found, the line number and a short
description of what is incorrect are displayed. Writes do not occur to the
RAC. This option is a check only.
Output
This subcommand generates error output upon encountering either of the
following:
Invalid syntax, group name, object name, index, or
other invalid database members
RACADM
utility transport failures
If errors are not encountered, this subcommand returns an indication of how
many configuration objects that were written out of how many total objects were
in the .cfg file.
getconfig Subcommand Description
The getconfig subcommand allows the user to retrieve RAC configuration
parameters on an individual basis, or all the configuration groups may be
retrieved and saved into a file.
Input
Table 6-8.
getconfig Subcommand Options
Option
Description
-f
The -f <filename>,
or filename option, causes getconfig to create the file <filename>.
It then reads all the configuration data from the RAC and places it into the
file <filename>.
The created file is a format that can be used with the racadm config -f
<filename>
command.
-p
The -p, or password option,
causes getconfig to include password information in the file for all
passwords except for the user passwords (which are stored encrypted and
cannot be decrypted). A # cfgUserAdmPassword line is displayed as an
indication that the password is present, but password text is not displayed.
-g
The -g <groupName>,
or group option, can be used to display the configuration for a
single group. The groupName is the name for the group used in the
racadm.cfg files. If the group is an indexed group, use the -i
option.
-h
The -h, or help option,
displays a list of all available configuration groups so the user may enter
the desired group. This option is useful when you do not remember exact
group names.
-i
The -i <index>,
or index option, is valid only for indexed groups and can be used to
specify a unique group. The <index> is a decimal integer from 1
through 16. If -i <index>
is not specified, a value of 1 is assumed for groups, which are tables that
have multiple entries. The index is specified by the index value, not a
“named” value.
-u
The -u <username>,
or user name option, can be used to display the configuration for the
specified user. The <username>
option is the log in user name for the user.
Output
This subcommand generates error output upon encountering either of the
following:
Invalid syntax, group name, object name, index, or
other invalid database members
RACADM
utility transport failures
If errors are not encountered, this subcommand displays the contents of the
specified configuration.
Examples
racadm getconfig -g
cfgLanNetworking
Displays all of the configuration parameters (objects) that
are contained in the group cfgLanNetworking.
Sets the cfgNicIpAddress configuration parameter
(object) to the value 10.35.10.110. This IP address object is contained in the
group cfgLanNetworking.
racadm getconfig -f myrac.cfg
Reads all of the configuration objects, from all of the
RAC group configuration parameters and place them in a file called myrac.cfg.
racadm config -f myrac.cfg
Configures or reconfigures the RAC. The myrac.cfg file
may be created from the command specified in the previous example if the RAC has
a desired configuration to be replicated. The myrac.cfg file may also be
edited manually as long as the parsing rules are followed.
NOTE: The myrac.cfg
file does not contain password information. To include this information in the
file, it must be input manually. If you want to remove password information from
the myrac.cfg file, use the -p option.
racadm getconfig -h
Displays a list of the available configuration groups on the
RAC.
racadm getconfig -u root
Displays the configuration parameters for the user named root.
fwupdate
NOTE: To use this
command, you must have Configure DRAC 4 permission.
The fwupdate subcommand allows the caller to update the firmware on
the DRAC 4. The user may:
Start updating a firmware update file that has
previously been loaded into the RAM disk update area.
Check the status of the firmware update process.
Instruct the DRAC 4 firmware to get the firmware update file from a TFTP
server and load it into the RAM disk area.
The user may specify the IP address and path/filename or IP
address and directory, or use the default values found in the database. The user
may also specify that the update be started after loading, or to terminate and
make a separate call to start the update process.
Load the update file into the DRAC 4 RAM disk
area.
Input
Table 6-10 describes the fwupdate
subcommand options.
NOTE: The -p and
-u options are not supported for the serial/telnet console.
Table 6-10. fwupdate
Subcommand Options
Option
Description
-u
The update option performs a
checksum of the firmware update file and starts the actual update process.
If this option is typed by itself, it is assumed that a firmware update file
has already been loaded into the RAM disk using the -g or -p
options. This option may also be used along with the -g or -p
options. After the firmware update file has been loaded, the update process
is started within the same call. At the end of the update, the DRAC 4
performs a soft reset.
-w
The wait option represents a delay
in seconds to wait before proceeding with the update. The -w option
is only valid with the -u option.
-s
The status option returns the
current status of where you are in the update process. This option is always
typed by itself. Do not type the -s options with other options. If
you do, the status will display as if it was the only option typed.
-g
The get option instructs the
firmware to get the firmware update file from the TFTP server and place it
in the RAM disk area. The user may also specify the -a and/or the
-f or -d options that are described next. In the absence of the
-a or -f options the defaults are read from properties contained
in the group cfgRemoteHosts, using properties
cfgRhostsFwUpdateIpAddr and cfgRhostsFwUpdatePath.
-a
The IP Address option specifies the
IP address of the TFTP server.
-d
The -d, or directory, option
specifies the directory on the TFTP server or on the DRAC 4’s host server
where the firmware update file resides. Do not use the -f option with
the -d option.
-c
The -c, or checksum, option
allows the user to verify an update file that has been loaded into the
RAM disk area. The update file can be loaded by one of the two loading
mechanisms (racadm CLI or TFTP). This option essentially gets the size of
the firmware update file and calculates the checksum, and verifies the file
token. The TFTP interface verifies the checksum after loading automatically.
This option is used mainly when using FTP. The -c option is not used
with other options. (The -u option will always checksum before
programming. It can be used along with the -u option).
-D
After the update is complete, the DRAC 4
is reset. Upon boot, a call is made to reset all firmware configuration
parameters to the default values. For more information, see "racresetcfg."
-p
The -p, or put, option is
used when you want to FTP the firmware update file from the managed system
to the DRAC 4. If the -f option is used, the name of the update image
must be firming.dm1. The update file is sent by way of FTP into the
DRAC 4. Checksum runs on the newly loaded image. If the checksum is not
correct, an error message is displayed. The user is not required to use
fwupdate -s option to do this. If you type the -u option on
the same command line, the update process starts.
Output
Displays a message indicating which operation is being performed.
Examples
racadm fwupdate -g - a 143.166.154.143 -f
firmimg.dm1
In this example, the -g option tells the firmware to
download the firmware update file from a location (specified by the -f
option) on the TFTP server at a specific IP address (specified by the -a
option). The update file is then loaded into RAM disk. Since the -u
option is not present, an update does not occur.
racadm fwupdate -s
This option reads the current status of the firmware update.
racadm fwupdate -u
The -u option starts the update process. This command
assumes that a valid firmware update file has been previously loaded using the
-g or -p option. The update file checksum is verified for correctness
before proceeding.
racadm fwupdate -g -u -a 143.166.154.143 -f
firmimg.dm1
In this example, the -g option tells the firmware to
download the firmware update file from a location (specified by the -f
option) on the TFTP server at a specific IP address (specified by the -a
option). The update file is then loaded into RAM disk. The -u option
tells the firmware to proceed with the update after the firmware is loaded.
Updating the Firmware
If you use the -f option, specify the firmimg.dm1 file.
If you are updating your firmware locally, use one of the following
commands to update your firmware:
NOTE: The -p
option does not support remote firmware updates.
getssninfo
Table 6-11. getssninfo
Subcommand
Command
Definition
getssninfo
Retrieves session information for one or
more currently active or pending sessions from the Session Manager's session
table.
Synopsis
racadm getssninfo [-A] [-u <username> | *]
Description
The getssninfo command returns a list of currently active or pending
users and optionally includes summary session table information. The summary
information provides the total number of sessions in each of the following
defined Session Manager states:
Free
Preliminary
Unvalidated
Valid
Invalid
Input
Table 6-12. getssninfo
Subcommand Options
Option
Description
-A
The -A option eliminates the
printing of data headers.
-u
The -u<username>
user name option limits the printed output to only the detail session
records for the given user name. If an * symbol is given as the user name,
all users are listed. Summary information is not printed when this option is
specified.
Output
None
Examples
racadm getssninfo
Session table summary status:
1 VALID
15 AVAILABLE
Type
---------
User
-------
IP Address
-------------
Login Date/Time
------------
Consoles
----------
Web
RAC
root 192.168.1.23
Thu, 06 Mar 2003 10:32:39 GMT-06:00
NONE
racadm getssninfo -A
1 15
"Web" "RAC\root" 192.168.1.23 "Thu, 06 Mar 2003 10:32:39
GMT-06:00" "NONE"
racadm getssninfo -A -u *
"Web" "RAC\root" 192.168.1.23 "Thu, 06 Mar 2003 10:32:39
GMT-06:00" "NONE"
getsysinfo
Table 6-13. getsysinfo
Subcommand
Command
Definition
getsysinfo
Displays RAC information, system
information, and watchdog status information.
Synopsis
racadm getsysinfo [-d] [-s] [-w] [-A][-c]
Description
The getsysinfo command returns information about the RAC, system, or
watchdog status, depending on the command options. The order of data on output
is always the same: RAC information, system information, and watchdog
information.
Input
Table 6-14. getsysinfo
Subcommand Options
Option
Description
-d
Displays RAC information.
-s
Displays system information.
-w
Displays watchdog information.
-A
Eliminates the printing of headers/labels.
-c
Displays chassis information.
If a -d, -s, or -w option is not specified, then these
three options are used as defaults.
Output
Every data element is output as a string with the exception of the following:
System information/operating system type
Watchdog information/recovery action
Enumeration values or bitmaps are defined for these elements. When the -A
(API) option is included on the command, the enumeration/bit value of the
element is listed in the output. Otherwise, the enumeration or bit value is
mapped to a string before being output.
The following bullet items define the mapping of values to strings:
Table 6-15. Mapping of
Values to Strings
Value
Description
System information/operating system type
A bitmap defines three subfields for this
value, as follows:
IA type - Bit position 0 (least significant bit):
0 = 32 bit, 1 = 64 bit
Major operating system - Bit positions 1–7:
000000 = Microsoft Windows 000001 = Red Hat� Enterprise Linux�, 000010
= Novell� NetWare�
Minor operating system - Bit positions 8–15:
0 = Red Hat Linux, 00000000 = Windows NT�, 00000001 = Windows 2000,
0 = NetWare
Displays the number of entries in the DRAC
4 trace log.
gettracelog
Displays the DRAC 4 trace log entries.
Synopsis
racadm gettracelog -i
racadm gettracelog -m
Description
The gettracelog -i command displays the number of entries in the DRAC
4 trace log. The gettracelog command (without the -i option) reads
entries.
The -m option displays 24 rows at a time, and queries for more (such
as the UNIX more command).
Output
One line of output is displayed for each trace log entry.
help
Table 6-18. help
Subcommand
Command
Definition
help
Lists all of the subcommands available to
use with the RACADM utility and provides a short description for each.
Synopsis
racadm help
racadm help <subcommand>
Description
The help subcommand lists all of the subcommands that are available
under the racadm
command along with a one-line description. You may also enter a subcommand after
help to get the syntax for a specific subcommand.
Input
None
Output
racadm help displays a complete list of subcommands.
racadm help
<subcommand>
displays usage information for the specified subcommand only.
racdump
Table 6-19. racdump
Subcommand
Command
Definition
racdump
Displays status and general RAC
information.
Synopsis
racadm racdump
Description
The racdump subcommand provides a single command to get a dump,
status, and general RAC board information with a single command.
The following commands are executed as a result of the single racdump
subcommand:
getsysinfo
coredump
memmap
netstat
getssninfo
getsensors
Input
None
Output
The output of the individual commands are displayed.
racreset
Table 6-20. racreset
Subcommand
Command
Definition
racreset
Resets the RAC.
Synopsis
racadm racreset [hard | soft | graceful] [delay]
Description
The racreset subcommand issues a reset to the RAC. The user is allowed
to select how many seconds of delay occur before the reset sequence is started.
The reset event is written into the RAC log.
The default option is soft. If you do not enter an option, the RACADM
utility waits three seconds and then runs the soft option with the
racreset subcommand.
NOTE: A reboot is not
necessary to apply configuration settings to the RAC. When the configuration
settings affect other system components, on the other hand, a reboot is
necessary for the affected components to detect the changes. For example, if
remote floppy boot is enabled by the RACADM utility, the remote floppy
image will not be accessible by the system until the next reboot.
Input
CAUTION: You must reboot your system after performing a hard
reset of the RAC as described in the following table.
Table 6-21. racreset
Subcommand Options
Option
Description
hard
A hard reset resets the entire RAC
and is as close to a power-on reset as can be achieved using software. The
RAC log, database, and selected daemons are shutdown gracefully prior to the
reset. A hard reset should be considered as a final effort. PCI
configuration is lost.
soft
A soft reset is a microprocessor
and microprocessor subsystem reset that resets the processor core to restart
the software. PCI configurations are preserved. The RAC log, database, and
selected daemons are shutdown gracefully prior to the reset.
graceful
A graceful reset is the same as a
soft reset.
<delay>
The user is allowed to select how many
seconds of delay occur before the reset sequence is started. A valid delay
entry is between 1–60 seconds. The default is 3 seconds.
Output
None
Examples
racadcm racreset soft 1
Start the RAC soft reset sequence in 1 second.
racadm racreset soft 20
Start the RAC soft reset sequence after 20 seconds.
racresetcfg
Table 6-22.
racresetcfg Subcommand
Command
Definition
racadm racresetcfg
Resets all database configuration
parameters to default values; equivalent to a soft reset.
Synopsis
racadm racresetcfg
Description
The racresetcfg command removes all database property entries that
have been configured by the user. The database has default properties for all
entries that are used to restore the card back to its original default settings.
After resetting the database properties, the RAC resets automatically.
CAUTION: Before using this command, ensure that you want to
restore your database to its original default state with default user
root and default password calvin.
NOTE: After issuing a
racresetcfg subcommand, stop and then restart the following services: Server
Agent, Server Agent Event Monitor, and SNMP. See the Dell OpenManage Server
Administrator’s User’s Guide for information on stopping and restarting the
services in your operating system.
Input
None
Output
None
setrac
Table 6-23. setrac
Subcommand
Command
Definition
setrac
Sets RAC parameters from the managed
system.
Synopsis
racadm setrac [-h -o -T -d]
Description
This command sets time, managed system name, operating system name, or
operating system type from the managed system to the RAC. If no options are
entered, all four parameters are set. The -d
option allows the user to display the parameters only without actually writing
them to the RAC firmware. Any combination of options, or no options, may be
entered.
Input
Table 6-24. setrac
Subcommand Options
Option
Description
-h
Gets the Hostname from the managed system
and writes it to the RAC. This parameter is available for viewing using the
getsysinfo
command, and under the object ID interface using config/getconfig
as [ifcRacManagedNodeOs] ifcRacMnOsHostname.
-o
Gets the OS Name from the managed system
and writes it to the RAC. This parameter is available for viewing under the
object ID interface using config/getconfig as [ifcRacManagedNodeOs]
ifcRacMnOsName.
-T
Gets the OS Type from the managed system
and writes it to the RAC. This parameter is available for viewing using the
getsysinfo command and under the object ID interface using config/getconfig
as [ifcRacManagedNodeOs] ifcRacMnOsOsType.
-d
The -d, or display option,
allows the user to get the UTC time,
Hostname,OS
Name, and OS Type from the managed system and display these items only.
Parameters are not written to the RAC. If the -d option is
entered along with other options, then those parameters are displayed only.
Output
A message is displayed indicating the values obtained from the managed
system, and if they are being written to the RAC or only displayed.
Examples
racadm setrac -d
Only the parameter values are displayed.
racadm setrac -h
The UTC time and managed system name are taken from the
managed system and written to the RAC.
DRAC Property Database Group
and Object Definitions
The Dell Remote Access Controller (DRAC) III, DRAC 4, DRAC 5, iDRAC, and
iDRAC6 property database contain the configuration information for the DRAC III,
DRAC 4, DRAC 5, iDRAC, and iDRAC6 controllers respectively.
For the property database group and object definitions of DRAC and iDRAC, see
the following guides on the Dell Support site at support.dell.com:
Integrated Dell Remote Access Controller User
Guide
