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.
A Deprecated and New Subcommands.............................. 653
B Legacy and New Groups and Objects..............................655
cfgSSADRoleGroupPrivilege (Read or Write)................................................ 671
1
Introduction
This document provides information about the RACADM subcommands,
supported RACADM interfaces, and property database groups and object
definitions for the following:
•iDRAC for Blade Servers
•iDRAC on Rack and Tower Servers
Most of the commands mentioned in this document are applicable for multigeneration servers. That is, the commands are applicable for iDRAC6, iDRAC7,
and iDRAC8. For more information on the commands applicable for a
particular iDRAC version, see the iDRAC RACADM Support Matrix available at
dell.com/esmmanuals.
NOTE:
•From iDRAC version 2.00.00.00, the guide provides information
specific to iDRAC. For information specific to Chassis Management
Controller (CMC) M1000e, refer to Chassis Management Controller
M1000e Version 5.0 RACADM Command Line Reference Guide
available at dell.com/support/manuals.
•The appendix section in the guide provides:
– List of deprecated subcommands.
– List of legacy groups and objects with the equivalent new groups
and objects.
New in This Release
•Support for --nocertwarn option in Remote RACADM version 8.0.1 to
not display the invalid certificate warning.
•Support to display the version for USC as Lifecycle Controller using the
getversion command.
11
•Support to erase the components by using the systemerase
subcommand to remove the server from use.
•Support to generate technical support report operations using the
techsupreport subcommand.
•Support to view the host network interface details using the
gethostnetworkinterfaces subcommand.
•Support to view the system performance monitoring operations using the
systemperfstatistics subcommand.
•Addition of --includePH option in the get subcommand to include
password hash attributes in the configuration .xml file.
•Support to perform sensor settings of the sensor using the
sensorsettings subcommand.
•Support the following for the PCIe SSD drives:
– Monitor or view properties
– Identify drives using blink and unblink command
•Addition of storage and system attributes to manage the backplane.
•Addition of system attributes to manage configuration and recovery of
QuickSync settings.
•Addition of TFTP and HTTP support to the autoupdatescheduler
subcommand.
•Support for real time raid configuration using storage and jobqueue
subcommands.
•Support to configure the SNMP alerts for SNMPv3 protocol.
•Support for configuring the front panel USB using the iDRAC.USB
attributes.
•Support for <Home>, <Delete>, <up>, and <down> arrow keys in the
RACADM shell.
•Addition of deprecated subcommands section.
•Addition of legacy groups and objects and equivalent groups and objects
section.
Supported RACADM Interfaces
The RACADM command-line utility provides a scriptable interface that allows
you to locally configure or remotely configure your Remote Access
12
Controller (RAC). The utility runs on the management station and the
managed system. It is available on the Dell OpenManage Systems Management and Documentation DVD or at support.dell.com.
The RACADM utility supports the following interfaces:
•Local — Supports running RACADM commands from the managed
server’s operating system. To run local RACADM commands, install the
OpenManage software on the managed server. Only one instance of Local
RACADM can be executed on a system at a time. If you try to open
another instance, an error message is displayed and the second instance
of Local RACADM closes immediately. To download the local RACADM
tool from support.dell.com, select Drivers and Downloads, select a
server, and then select Systems Management → Dell Toolkit.
•SSH or Telnet — Also known as Firmware RACADM. Firmware RACADM is
accessible by logging in to iDRAC using SSH or Telnet. You do not have to
specify the iDRAC IP, user name or password to run Firmware RACADM
commands. Similar to Local RACADM, at the RACADM prompt, directly
run the commands without the RACADM prefix.
•Remote — Supports running RACADM commands from a remote
management station such as a laptop or desktop. To run Remote
RACADM commands, install the DRAC Tools utility from the OpenManage
software on the remote computer. To run Remote RACADM commands:
– Formulate the command as a Local or SSH/Telnet RACADM command.
– In addition, specify –r –i options or the –r –u –p options.
For more information about the options, see RACADM Subcommand
Details. To download the local RACADM tool from dell.com/support, click
Servers, Storage & Networking in the General Support section. Click
PowerEdge, click the required PowerEdge system, and then click Drivers
& downloads.
RACADM Syntax Usage
The following section describes the syntax usage for Local, SSH/Telnet, and
Remote RACADM.
SSH, Telnet, or Local RACADM
racadm get <devicename>.<groupname>.[<index>].
[<objectname>]
racadm set <devicename>.<groupname>.[<index>].<objectname>
<value>
racadm <subcommand>
13
Example
racadm get idrac.info
racadm getsysinfo
Remote RACADM
racadm -r <racIpAddr> -u <username> -p <password> get
<devicename>.<groupname>.[<index>].[<objectname>]
racadm -r <racIpAddr> -u <username> -p <password> set
<devicename>.<groupname>.[<index>].<objectname> <value>
racadm -r 192.168.1.0 -u root -p xxxx get idrac.ssh.port
Security Alert: Certificate is invalid - Certificate is
not signed by Trusted Third Party Continuing execution.
Use -S option for racadm to stop execution on certificaterelated errors. [Key=idrac.Embedded.1#SSH.1] Port=22
NOTE: The following command will not display the security error.
racadm -r 192.168.0.0 -u root -p xxxx set idrac.ssh.port 22
racadm -r 192.168.0.0 -u root -p xxxx getsysinfo
racadm -r 192.168.0.0 -u root -p xxxx --nocertwarn get
idrac.ssh.port
Accessing Indexed-Based Device Groups and Objects
•To access any object, run the following syntax:
device.<group name>.[<index>].<object name>
•To display the supported indexes for a specified group, run:
•To display a single object for the specified group, run:
racadm get device.<group name>.<index>.<object name>
Example
racadm get nic.nicconfig.3.legacybootproto
[Key=NIC.Integrated.1-3#NICConfig]
Legacybootproto=PXE
RACADM Command Options
The following table lists the options for the RACADM command:
OptionDescription
-r <racIpAddr>
-r <racIpAddr> : <port
number>
-u <username>
-p <password>
-S
Specifies the controller’s remote IP
address.
Use <port number> if the iDRAC port
number is not the default port (443).
Specifies the user name that is used to
authenticate the command transaction.
If the-u option is used, the -p option
must be used, and the -i option
(interactive) is not allowed.
Specifies the password used to
authenticate the command transaction.
If the -p option is used, the -i option is
not allowed.
Specifies that RACADM must check for
invalid certificate errors. RACADM stops
the execution of the command with an
15
OptionDescription
error message if it detects an invalid
certificate.
--nocertwarn
NOTE: Up to four instances of remote RACADM can be executed on a
management station, while only one instance of local RACADM can be
executed on a managed node.
Does not display certificate related
warning message.
Using The Autocomplete Feature
Use the autocomplete feature to:
•Display all the available RACADM commands in the alphabetical order on
pressing the <Tab> key at the prompt.
•View the complete list, enter the starting letter of the command at the
prompt and press <Tab> key.
•Navigate the cursor within a command, press:
<Home> key: directs to the beginning of the command.
<End > key: directs to the end of the command.
•View the history of the commands that were run in the current session,
press up and down arrow key.
•Exit the Autocomplete mode, enter Quit, Exit, or press <Ctrl+D> key.
racadm> getled <press enter> or <racadm getled>
LEDState: Not-Blinking
Supported RACADM Subcommands
The following table provides the list of RACADM subcommands and their
corresponding interface support. For more information about the RACADM
subcommands including syntax and valid entries, see RACADM Subcommand
Details.
SubcommandiDRAC on Blade Servers iDRAC on Rack and
Telnet/S
SH/Serial
autoupdateschedulerYesYesYesYesYesYes
arpYesYesYesYesYesYes
Loca
l
RAC
ADM
Rem
ote
RACA
DM
Tower Servers
Telnet/
SSH/
Serial
Local
RACA
DM
Rem
ote
RAC
ADM
17
SubcommandiDRAC on Blade Servers iDRAC on Rack and
Telnet/S
SH/Serial
clearasrscreenYesYesYesYesYesYes
clearpendingYesYesYesYesYesYes
closessnYesYesYesYesYesYes
clrselYesYesYesYesYesYes
configYesYesYesYesYesYes
coredumpYesYesYesYesYesYes
coredumpdeleteYesYesYesYesYesYes
diagnosticsYesYesYesYesYesYes
eventfiltersYesYesYesYesYesYes
fcstatisticsYesYesYesYesYesYes
frontpanelerrorYesYesYesYesYesYes
fwupdateYesYesYesYesYesYes
getYesYesYesYesYesYes
Loca
l
RAC
ADM
Rem
ote
RACA
DM
Tower Servers
Telnet/
SSH/
Serial
Local
RACA
DM
Rem
ote
RAC
ADM
getconfigYesYesYesYesYesYes
gethostnetworkinterfacesYesYesYesYesYesYes
getledYesYesYesYesYesYes
getniccfgYesYesYesYesYesYes
getraclogYesYesYesYesYesYes
getractimeYesYesYesYesYesYes
getselYesYesYesYesYesYes
getsensorinfoYesYesYesYesYesYes
getssninfoYesYesYesYesYesYes
getsvctagYesYesYesYesYesYes
getsysinfoYesYesYesYesYesYes
18
SubcommandiDRAC on Blade Servers iDRAC on Rack and
Telnet/S
SH/Serial
gettracelogYesYesYesYesYesYes
getversionYesYesYesYesYesYes
Loca
l
RAC
ADM
Rem
ote
RACA
DM
Tower Servers
Telnet/
SSH/
Serial
Local
RACA
DM
Rem
ote
RAC
ADM
help and help
subcommand
hwinventoryYesYesYesYesYesYes
ifconfigYesYesYesYesYesYes
inlettemphistoryYesYesYesYesYesYes
jobqueueYesYesYesYesYesYes
krbkeytabuploadNoYesYesNoYesYes
lclogYesYesYesYesYesYes
licenseYesYesYesYesYesYes
nicstatisticsYesYesYesYesYesYes
pingYesYesYesYesYesYes
ping6YesYesYesYesYesYes
racdumpYesNoYesYesYesYes
racresetYesYesYesYesYesYes
racresetcfgYesYesYesYesYesYes
remoteimageYesYesYesYesYesYes
rollback YesYesYesYesYesYes
YesYesYesYesYesYes
sensorsettingYesYesYesYesYesYes
serveractionYesYesYesYesYesYes
setYesYesYesYesYesYes
setledYesYesYesYesYesYes
setniccfgYesYesYesYesYesYes
19
SubcommandiDRAC on Blade Servers iDRAC on Rack and
Telnet/S
SH/Serial
sshpkauthYesYesYesYesYesYes
sslcertuploadNoYesYesNoYesYes
sslcertviewYesYesYesYesYesYes
sslcertdeleteYesYesYesYesYesYes
sslcsrgenYesYesYesYesYesYes
sslkeyuploadNoYesYesNoYesYes
sslresetcfgYesYesYesYesYesYes
storageYesYesYesYesYesYes
swinventoryYesYesYesYesYesYes
systemconfigYesYesYesYesYesYes
systemeraseYesYesYesYesYesYes
systemperfstatisticsYesYesYesYesYesYes
techsupreportYesYesYesYesYesYes
Loca
l
RAC
ADM
Rem
ote
RACA
DM
Tower Servers
Telnet/
SSH/
Serial
Local
RACA
DM
Rem
ote
RAC
ADM
testemailYesYesYesYesYesYes
testtrapYesYesYesYesYesYes
testalertYesYesYesYesYesYes
tracerouteYesYesYesYesYesYes
traceroute6YesYesYesYesYesYes
updateYesYesYesYesYesYes
usercertuploadNoYesYesNoYesYes
usercertviewYesYesYesYesYesYes
vflashsdYesYesYesYesYesYes
vflashpartitionYesYesYesYesYesYes
vmdisconnectYesYesYesYesYesYes
20
Other Documents You May Need
In addition to this guide, you can access the following guides available on the
Dell Support website at www.dell.com/esmmanuals. To access the
documents, click the appropriate product link.
•The Integrated Dell Remote Access Controller 8 (iDRAC8) User’s Guide
provides information about configuring and using an iDRAC to remotely
manage and monitor your system and its shared resources through a
network.
•The iDRAC RACADM Support Matrix provides the list of sub commands
and objects that are applicable for a particular iDRAC version.
•Documentation specific to your third-party management console
application.
•The Dell OpenManage Server Administrator’s User’s Guide provides
information about installing and using Dell OpenManage Server
Administrator.
•The Dell Update Packages User's Guide provides information about
obtaining and using Dell Update Packages as part of your system update
strategy.
•The Glossary provides information about the terms used in this document.
The following system documents are also available to provide more
information about the system in which iDRAC is installed:
•The Hardware Owner’s Manual provides information about system
features and describes how to troubleshoot the system and install or
replace system components.
•Documentation for any components you purchased separately provides
information to configure and install the options.
•Release notes or readme files may be included to provide last-minute
updates to the system or documentation or advanced technical reference
material intended for experienced users or technicians.
Updates are sometimes included with the system to describe changes to the
system, software, and/or documentation. Always read the updates first
because they often supersede information in other documents.
See the Safety and Regulatory information that is shipped with your system.
NOTE: Warranty information may be included within this document or
as a separate document.
21
Accessing documents from Dell support
site
You can access the required documents in one of the following ways:
•Using the following links:
– For all Systems Management documents — dell.com/
softwaresecuritymanuals
– For Remote Enterprise Systems Management documents — dell.com/
esmmanuals
– For Enterprise Systems Management documents — dell.com/
openmanagemanuals
– For Client Systems Management documents — dell.com/
clientsystemsmanagement
– For Serviceability Tools documents — dell.com/serviceabilitytools
– For OpenManage Connections Enterprise Systems Management
documents — dell.com/
OMConnectionsEnterpriseSystemsManagement
– For OpenManage Connections Client Systems Management
a.Go to dell.com/support/manuals.
b.Under General support section, click Software & Security.
c.In the Software & Security group box, click the required link from the
following:
– Serviceability Tools
– Enterprise Systems Management
– Client Systems Management
– Remote Enterprise 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.
22
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.
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.Go to dell.com/support.
2.Select your support category.
3.Verify your country or region in the Choose a Country/Region drop-
down list at the top of page.
4.Select the appropriate service or support link based on your need.
23
2
RACADM Subcommand Details
This section provides detailed description of the RACADM subcommands
including the syntax and valid entries.
Guidelines to Quote Strings Containing
Special Characters When Using RACADM
Commands
When using strings that contain special characters, use the following
guidelines:
Strings containing the following special characters must be quoted using
single quotation marks or double quotation marks:
•$ (dollar sign)
•" (double quote)
•' (single quote)
•` (back quote)
•\ (backslash)
•~ (tilde)
•; (semicolon)
•| (vertical bar)
•( (left parentheses)
•) (right parentheses)
•& (ampersand)
•> (greater than)
•< (less than)
•# (pound)
•ASCII code 32 (space)
24
There are different escaping rules for using single quotation marks versus
double quotation marks.
For using double quotation marks:
The following characters must be escaped by prepending a backslash:
•$ (dollar sign)
•" (double quote)
•` (back quote)
•\ (back slash)
For example, use the following for a string that contains the special
characters, $, ",',`and \
For using single quotation marks:
•No character escaping is necessary.
•A single quotation mark is not used even with a back slash escaped.
NOTE: An empty string may be specified as either ” “(using double
quotation marks) or ' '(using single quotation marks).
help and help <subcommand>
Descripti
on
Synopsis
Input
Lists all the subcommands available for use with RACADM and
provides a short description about each subcommand. You may
also type a subcommand, group, object or Fully Qualified
Descriptor (FQDD) name after help.
•racadm help
•racadm help <subcommand>
•racadm help <device name>.<Group>
•racadm help <device name>.<Group>.<object>
•<subcommand> — specifies the subcommand for which you
need the help information.
•<device name> — specifies the device name such as
iDRAC, BIOS, NIC, LifecycleController, FC, system, or
Storage.
•<group> — specifies the group name supported by the
corresponding device.
25
•<object> — specifies the object for the entered group.
Output
Example
arp
Descripti
on
Synopsis
Input
Example
•The help command displays a complete list of
subcommands.
•The racadm help <subcommand> command displays
information for the specified subcommand only.
•The racadm help <device name> <Group> command
displays information for the specified group.
•The racadm help <device name> <Group> <Object>
command displays information for the specified object.
racadm help idrac.lcd
racadm help system.power
Displays the contents of the Address Resolution Protocol (ARP)
table. ARP table entries cannot be added or deleted.
To use this subcommand, you must have Debug privilege.
racadm arp
None
racadm arp
(10.00.1.1) at bc:16:65:d7:27:43 [either] on
bond0
Output
IP Address HW Type Flags HW
192.168.
1.1
26
0x10x200:00:0C
Address
:07:AC:
0F
Mask Device
*eth0
autoupdatescheduler
DescriptionYou can automatically update the firmware of the devices on
the server.
To run this subcommand, you must have the Server Control
privilege.
NOTE:
•The autoupdatescheduler subcommand can be
enabled or disabled.
•Lifecycle Controller and CSIOR may not be enabled to
run this subcommand.
•The autoupdatescheduler can be enabled or disabled.
For more information, see
LifecycleController.LCAttributes.autoupdate (Read or
Write)
•The minimum Lifecycle Controller version required is
Lifecycle Controller 1.3.
•When a job is already scheduled and the clear
command is run, the scheduling parameters are
cleared.
•If the network share is not accessible or the catalog file
is missing when the job is scheduled, then the job is
unsuccessful.
Synopsis
•To create the AutoUpdateScheduler, run the command.
•To view AutoUpdateScheduler parameter, run the
command.
racadm autoupdatescheduler view
•To clear and display AutoUpdateScheduler parameter, run
the command.
racadm autoupdatescheduler clear
NOTE: After the parameters are cleared, the
AutoUpdateSchedular is disabled. To schedule the
update again, enable the AutoUpdateScheduler.
27
InputValid options:
•-u — Specifies the user name of the remote share that
stores the catalog file.
NOTE: For CIFS, enter the domain name as domain or
username.
•-p — Specifies the password of the remote share that stores
the catalog file.
•-l — Specifies the network share (NFS, CIFS, FTP, TFTP, or
HTTP) location of the catalog file. IPv4 and IPv6 addresses
are supported.
•-f — Specifies the catalog location and the filename. If the
filename is not specified, then the default file used is
catalog.xml.
NOTE: If the file is in a subfolder within the share
location, then enter the network share location in the –
l option and enter the subfolder location and the
filename in the –f option.
•-ph — Specifies the FTP/HTTP proxy host name.
•-pu — Specifies the FTP/HTTP proxy user name.
•
•-pp — Specifies the FTP/HTTP proxy password.
•-po — Specifies the FTP/HTTP proxy port.
•-pt — Specifies the FTP/HTTP proxy type.
•-time — Specifies the time to schedule an autoupdate in
the HH:MM format. This option must be specified.
•-dom — Specifies the day of month to schedule an
autoupdate. Valid values are 1–28, L (Last day) or '*' (default
— any day).
•-wom — Specifies the week of month to schedule an
autoupdate. Valid values are 1–4, L (Last week) or '*' (default
— any week).
•-dow — Specifies the day of week to schedule an
autoupdate. Valid values are sun, mon, tue, wed, thu, fri, sat,
or '*' (default — any day).
28
NOTE: The -dom, -wom, or -dow option must be included
in the command for the autoupdate schedule. The * value
for the options must be included within ' ' (single quotation
mark).
•If the -dom option is specified, then the -wom and -dow
options are not required.
•If the-wom option is specified, then the-dow is required
and -dom is not required.
•If the-dom option is non-'*', then the schedule repeats
by month.
•If the-wom option is non-'*', then the schedule repeats
by month.
•If the-dom and -wom options are '*' and the -dow
option is non-'*', then the schedule repeats by week.
•If all the three -dom, -wom and -dow options are '*',
then the schedule repeats by day.
•-rp — Specifies the repeat parameter. This parameter must
be specified.
– If the-dom option is specified, then the valid values for -
are 1–12.
rp
– If the-wom option is specified, then the valid values for -
are 1–52.
rp
– If the-dow option is specified, then the valid values for -
rp are 1–366.
•-a — Applies reboot (1 — Yes, 0 — No). This option must be
specified.