Dell iDRAC8 with Lifecycle Controller Version 2.00.00.00 Manual

Integrated Dell Remote Access Controller 8 (iDRAC8) Version
2.00.00.00 RACADM 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 © 2014 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.
2014 - 09
Rev. A00
Contents
1 Introduction.............................................................................11
New in This Release..........................................................................................11
Supported RACADM Interfaces....................................................................... 12
RACADM Syntax Usage....................................................................................13
SSH, Telnet, or Local RACADM..................................................................13
Remote RACADM.......................................................................................14
Accessing Indexed-Based Device Groups and Objects........................... 14
RACADM Command Options.................................................................... 15
Using The Autocomplete Feature............................................................. 16
Supported RACADM Subcommands...............................................................17
Other Documents You May Need...................................................................21
Accessing documents from Dell support site................................................ 22
Contacting Dell................................................................................................23
2 RACADM Subcommand Details...........................................24
Guidelines to Quote Strings Containing Special Characters When Using
RACADM Commands...................................................................................... 24
help and help <subcommand>....................................................................... 25
arp.................................................................................................................... 26
autoupdatescheduler.......................................................................................27
cd......................................................................................................................30
cd...................................................................................................................... 31
clearasrscreen.................................................................................................. 31
clearpending.................................................................................................... 32
closessn............................................................................................................32
clrsel................................................................................................................. 33
config............................................................................................................... 34
coredump........................................................................................................ 36
coredumpdelete.............................................................................................. 36
diagnostics....................................................................................................... 37
eventfilters........................................................................................................39
fcstatistics.........................................................................................................41
frontpanelerror................................................................................................ 42
fwupdate.......................................................................................................... 42
get.................................................................................................................... 45
getconfig..........................................................................................................48
gethostnetworkinterfaces............................................................................... 50
getled................................................................................................................51
getniccfg.......................................................................................................... 52
getraclog..........................................................................................................54
getractime........................................................................................................55
getsel................................................................................................................56
getsensorinfo...................................................................................................56
getssninfo.........................................................................................................62
getsvctag..........................................................................................................63
getsysinfo.........................................................................................................63
gettracelog.......................................................................................................66
getversion.........................................................................................................67
hwinventory.....................................................................................................69
ifconfig............................................................................................................. 74
inlettemphistory...............................................................................................75
jobqueue...........................................................................................................77
krbkeytabupload.............................................................................................. 78
lclog..................................................................................................................79
license.............................................................................................................. 83
nicstatistics.......................................................................................................86
ping...................................................................................................................87
ping6................................................................................................................ 88
racdump...........................................................................................................88
racreset............................................................................................................ 92
racresetcfg....................................................................................................... 93
remoteimage................................................................................................... 94
rollback............................................................................................................ 96
sensorsettings..................................................................................................96
serveraction......................................................................................................97
set.....................................................................................................................98
setled.............................................................................................................. 101
setniccfg.........................................................................................................101
sshpkauth.......................................................................................................102
sslcertdownload............................................................................................ 104
sslcertupload..................................................................................................105
sslcertview..................................................................................................... 106
sslcertdelete...................................................................................................108
sslcsrgen........................................................................................................ 109
sslkeyupload...................................................................................................110
sslresetcfg.......................................................................................................110
storage............................................................................................................ 111
swinventory....................................................................................................128
systemconfig..................................................................................................129
systemerase....................................................................................................133
systemperfstatistics........................................................................................134
techsupreport.................................................................................................135
testemail......................................................................................................... 137
testtrap........................................................................................................... 138
testalert.......................................................................................................... 139
traceroute.......................................................................................................139
traceroute6.................................................................................................... 140
update............................................................................................................ 140
usercertupload...............................................................................................144
usercertview...................................................................................................144
vflashsd...........................................................................................................145
vflashpartition................................................................................................ 146
vmdisconnect................................................................................................ 148
3 iDRAC Property Database Group and Object
Descriptions............................................................................. 149
Displayable Characters..................................................................................149
idRacInfo........................................................................................................ 152
cfgStaticLanNetworking................................................................................ 154
cfgRemoteHosts............................................................................................ 157
cfgUserAdmin................................................................................................ 160
cfgEmailAlert..................................................................................................167
cfgSessionManagement................................................................................168
cfgSerial.......................................................................................................... 171
cfgOobSnmp..................................................................................................175
cfgRacTuning.................................................................................................176
ifcRacManagedNodeOs................................................................................ 184
cfgRacVirtual..................................................................................................185
cfgServerInfo..................................................................................................187
cfgActiveDirectory.........................................................................................189
cfgLDAP..........................................................................................................195
cfgLdapRoleGroup........................................................................................ 199
cfgStandardSchema...................................................................................... 201
cfgThermal.................................................................................................... 203
cfgIpmiSol......................................................................................................203
cfgIpmiLan.....................................................................................................205
cfgIpmiPetIpv6.............................................................................................. 206
cfgIpmiPef......................................................................................................207
cfgIpmiPet..................................................................................................... 209
cfgUserDomain..............................................................................................210
cfgServerPower.............................................................................................. 211
cfgServerPowerSupply.................................................................................. 223
cfgIPv6LanNetworking..................................................................................225
cfgIpv6StaticLanNetworking.........................................................................232
cfgIPv6URL.................................................................................................... 234
cfgIpmiSerial.................................................................................................. 235
cfgSmartCard................................................................................................ 238
cfgNetTuning.................................................................................................239
cfgSensorRedundancy.................................................................................. 241
cfgVFlashSD...................................................................................................242
cfgVFlashPartition..........................................................................................245
cfgLogging.....................................................................................................247
cfgRacSecurity...............................................................................................248
4 Database Objects With Get and Set Commands............251
System.Backplane..........................................................................................252
System.ChassisInfo........................................................................................253
System.QuickSync.........................................................................................254
System.LCD................................................................................................... 256
System.Location............................................................................................ 258
System.Power................................................................................................262
System.Power.Supply....................................................................................283
System.ServerOS........................................................................................... 287
System.ThermalSettings................................................................................289
System.ThermalConfig..................................................................................294
LifecycleController.LCAttributes.................................................................. 296
iDRAC.ActiveDirectory.................................................................................. 302
iDRAC.ADGroup............................................................................................. 311
iDRAC.AutoOSLock........................................................................................312
iDRAC.EmailAlert............................................................................................313
iDRAC.Info......................................................................................................314
iDRAC.IOIDOpt...............................................................................................317
iDRAC.IPBlocking...........................................................................................321
iDRAC.IPMILan...............................................................................................324
iDRAC.IPMISerial............................................................................................327
iDRAC.IPMISOL..............................................................................................332
iDRAC.IPv4.....................................................................................................334
iDRAC.IPv4Static............................................................................................338
iDRAC.IPv6..................................................................................................... 341
iDRAC.IPv6Static............................................................................................353
iDRAC.IPv6URL.............................................................................................. 355
iDRAC.LDAP...................................................................................................356
iDRAC.LDAPRoleGroup................................................................................. 361
iDRAC.LocalSecurity......................................................................................362
iDRAC.Logging.............................................................................................. 363
iDRAC.NIC..................................................................................................... 364
iDRAC.NICStatic.............................................................................................374
iDRAC.NTPConfigGroup............................................................................... 375
iDRAC.OS-BMC............................................................................................. 378
iDRAC.Racadm..............................................................................................380
iDRAC.RemoteHosts......................................................................................381
iDRAC.RFS......................................................................................................382
iDRAC.RSM.................................................................................................... 383
iDRAC.Security.............................................................................................. 384
iDRAC.Serial................................................................................................... 387
iDRAC.SerialRedirection................................................................................ 391
iDRAC.serverboot..........................................................................................392
iDRAC.ServiceModule................................................................................... 393
iDRAC.SmartCard.......................................................................................... 397
iDRAC.SNMP..................................................................................................398
iDRAC.SNMP.Alert......................................................................................... 401
iDRAC.SSH.....................................................................................................403
iDRAC.SysLog................................................................................................405
iDRAC.Telnet.................................................................................................408
iDRAC.Time....................................................................................................410
iDRAC.Tuning................................................................................................. 411
iDRAC.Update................................................................................................ 412
iDRAC.USB..................................................................................................... 413
iDRAC.UserDomain....................................................................................... 414
iDRAC.Users................................................................................................... 415
iDRAC.vflashpartition.....................................................................................421
iDRAC.vflashsd.............................................................................................. 424
iDRAC.VirtualConsole....................................................................................427
iDRAC.VirtualMedia....................................................................................... 432
iDRAC.VNCServer..........................................................................................434
iDRAC.WebServer..........................................................................................436
BIOS.BiosBootSettings..................................................................................439
BIOS.EmbServerMgmt...................................................................................443
BIOS.IntegratedDevices................................................................................444
BIOS.MemSettings.........................................................................................454
BIOS.MiscSettings..........................................................................................461
BIOS.NetworkSettings...................................................................................466
BIOS.OneTimeBoot.......................................................................................466
BIOS.ProcSettings......................................................................................... 469
BIOS.ProxyAttributes.....................................................................................493
BIOS.PxeDevice1Settings..............................................................................494
BIOS.SataSettings..........................................................................................496
BIOS.SerialCommSettings............................................................................. 515
BIOS.SlotDisablement....................................................................................518
BIOS.SysInformation..................................................................................... 524
BIOS.SysProfileSettings................................................................................. 527
BIOS.SysSecurity............................................................................................536
BIOS.UefiBootSettings.................................................................................. 548
FC.FCDevice.................................................................................................. 550
FC.FCTarget...................................................................................................552
FC.HBAConfig................................................................................................554
FC.PortConfig................................................................................................559
NIC.ConfigureFormn.................................................................................... 564
NIC.DCBSettings............................................................................................ 571
NIC.DeviceLevelConfig................................................................................. 573
NIC.FCOECapabilities....................................................................................575
NIC.FCoEConfiguration................................................................................ 579
NIC.FCoEGenParams....................................................................................584
NIC.FrmwImgMenu....................................................................................... 587
NIC.GlobalBandwidthAllocation...................................................................588
NIC.IscsiFirstTgtParams................................................................................ 589
NIC.IscsiGenParams......................................................................................594
NIC.IscsiInitiatorParams................................................................................ 601
NIC.IscsiSecondaryDeviceParams................................................................605
NIC.IscsiSecondTgtParams...........................................................................607
NIC.NICConfig............................................................................................... 611
NIC.NICPartitioningConfig............................................................................ 617
NIC.VndrConfigGroup...................................................................................619
Storage.Controller.........................................................................................637
Storage.enclosure......................................................................................... 645
Storage.PhysicalDisk..................................................................................... 647
Storage.VirtualDisk........................................................................................649
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 multi­generation 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 ManagementDell 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 <racIpAddr> -u <username> -p <password> <subcommand>
Example
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 certificate­related 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:
racadm get device.<group name>
Example
racadm get nic.nicconfig NIC.nicconfig.1 [Key=NIC.Integrated.1-1-1#nicconfig] NIC.nicconfig.2 [Key=NIC.Integrated.1-2-1#nicconfig] NIC.nicconfig.3 [Key=NIC.Integrated.1-3-1#nicconfig] NIC.nicconfig.4 [Key=NIC.Integrated.1-4-1#nicconfig]
To display the object list for the specified group, run:
racadm get device.<group name>.<index>
14
Example
racadm get nic.nicconfig.2 [Key=NIC.Integrated.1-2-1#nicconfig] BannerMessageTimeout=5 BootStrapType=AutoDetect HideSetupPrompt=Disabled LegacyBootProto=NONE LnkSpeed=AutoNeg #VLanId=1 VLanMode=Disabled
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:
Option Description
-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
Option Description
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.
For example:
Example 1: racadm> <press tab>
arp autoupdatescheduler clearasrscreen clearpending closessn clrraclog . . .
16
. . . . vflashsd vflashpartition vmdisconnect cd quit
Example 2: racadm> get <press tab>
get getconfig getled getniccfg getraclog getractime getsel getsensorinfo getssninfo getsvctag getsysinfo gettracelog getversion
Example 3:
racadm> getl<press tab>
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.
Subcommand iDRAC on Blade Servers iDRAC on Rack and
Telnet/S SH/Serial
autoupdatescheduler Yes Yes Yes Yes Yes Yes
arp Yes Yes Yes Yes Yes Yes
Loca l RAC ADM
Rem ote RACA DM
Tower Servers Telnet/
SSH/ Serial
Local RACA DM
Rem ote RAC ADM
17
Subcommand iDRAC on Blade Servers iDRAC on Rack and
Telnet/S SH/Serial
clearasrscreen Yes Yes Yes Yes Yes Yes
clearpending Yes Yes Yes Yes Yes Yes
closessn Yes Yes Yes Yes Yes Yes
clrsel Yes Yes Yes Yes Yes Yes
config Yes Yes Yes Yes Yes Yes
coredump Yes Yes Yes Yes Yes Yes
coredumpdelete Yes Yes Yes Yes Yes Yes
diagnostics Yes Yes Yes Yes Yes Yes
eventfilters Yes Yes Yes Yes Yes Yes
fcstatistics Yes Yes Yes Yes Yes Yes
frontpanelerror Yes Yes Yes Yes Yes Yes
fwupdate Yes Yes Yes Yes Yes Yes
get Yes Yes Yes Yes Yes Yes
Loca l RAC ADM
Rem ote RACA DM
Tower Servers Telnet/
SSH/ Serial
Local RACA DM
Rem ote RAC ADM
getconfig Yes Yes Yes Yes Yes Yes
gethostnetworkinterfaces Yes Yes Yes Yes Yes Yes
getled Yes Yes Yes Yes Yes Yes
getniccfg Yes Yes Yes Yes Yes Yes
getraclog Yes Yes Yes Yes Yes Yes
getractime Yes Yes Yes Yes Yes Yes
getsel Yes Yes Yes Yes Yes Yes
getsensorinfo Yes Yes Yes Yes Yes Yes
getssninfo Yes Yes Yes Yes Yes Yes
getsvctag Yes Yes Yes Yes Yes Yes
getsysinfo Yes Yes Yes Yes Yes Yes
18
Subcommand iDRAC on Blade Servers iDRAC on Rack and
Telnet/S SH/Serial
gettracelog Yes Yes Yes Yes Yes Yes
getversion Yes Yes Yes Yes Yes Yes
Loca l RAC ADM
Rem ote RACA DM
Tower Servers Telnet/
SSH/ Serial
Local RACA DM
Rem ote RAC ADM
help and help subcommand
hwinventory Yes Yes Yes Yes Yes Yes
ifconfig Yes Yes Yes Yes Yes Yes
inlettemphistory Yes Yes Yes Yes Yes Yes
jobqueue Yes Yes Yes Yes Yes Yes
krbkeytabupload No Yes Yes No Yes Yes
lclog Yes Yes Yes Yes Yes Yes
license Yes Yes Yes Yes Yes Yes
nicstatistics Yes Yes Yes Yes Yes Yes
ping Yes Yes Yes Yes Yes Yes
ping6 Yes Yes Yes Yes Yes Yes
racdump Yes No Yes Yes Yes Yes
racreset Yes Yes Yes Yes Yes Yes
racresetcfg Yes Yes Yes Yes Yes Yes
remoteimage Yes Yes Yes Yes Yes Yes
rollback Yes Yes Yes Yes Yes Yes
Yes Yes Yes Yes Yes Yes
sensorsetting Yes Yes Yes Yes Yes Yes
serveraction Yes Yes Yes Yes Yes Yes
set Yes Yes Yes Yes Yes Yes
setled Yes Yes Yes Yes Yes Yes
setniccfg Yes Yes Yes Yes Yes Yes
19
Subcommand iDRAC on Blade Servers iDRAC on Rack and
Telnet/S SH/Serial
sshpkauth Yes Yes Yes Yes Yes Yes
sslcertupload No Yes Yes No Yes Yes
sslcertview Yes Yes Yes Yes Yes Yes
sslcertdelete Yes Yes Yes Yes Yes Yes
sslcsrgen Yes Yes Yes Yes Yes Yes
sslkeyupload No Yes Yes No Yes Yes
sslresetcfg Yes Yes Yes Yes Yes Yes
storage Yes Yes Yes Yes Yes Yes
swinventory Yes Yes Yes Yes Yes Yes
systemconfig Yes Yes Yes Yes Yes Yes
systemerase Yes Yes Yes Yes Yes Yes
systemperfstatistics Yes Yes Yes Yes Yes Yes
techsupreport Yes Yes Yes Yes Yes Yes
Loca l RAC ADM
Rem ote RACA DM
Tower Servers Telnet/
SSH/ Serial
Local RACA DM
Rem ote RAC ADM
testemail Yes Yes Yes Yes Yes Yes
testtrap Yes Yes Yes Yes Yes Yes
testalert Yes Yes Yes Yes Yes Yes
traceroute Yes Yes Yes Yes Yes Yes
traceroute6 Yes Yes Yes Yes Yes Yes
update Yes Yes Yes Yes Yes Yes
usercertupload No Yes Yes No Yes Yes
usercertview Yes Yes Yes Yes Yes Yes
vflashsd Yes Yes Yes Yes Yes Yes
vflashpartition Yes Yes Yes Yes Yes Yes
vmdisconnect Yes Yes Yes Yes Yes Yes
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
documents — dell.com/connectionsclientsystemsmanagement
From the Dell Support site:
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 ManagementClient Systems ManagementRemote Enterprise Systems ManagementConnections 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
0x1 0x2 00: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.
racadm autoupdatescheduler create -u <user> ­p <password> -l <location> -f <filename> ­time <time> -dom <DayOfMonth> -wom <WeekOfMonth> -dow <DayofWeek> -rp <repeat> ­a <applyreboot> -ph <proxyHost> -pu <proxyUser> -pp <proxyPassword> -po <proxyPort> -pt <proxyType>
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
Input Valid 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.
Example Usage examples:
To configure autoupdate feature settings.
– For CIFS, run the command:
racadm autoupdatescheduler create -u Americas/admin -p pwd -l //1.2.3.4/share ­f cat.xml -time 14:30 -wom 1 -dow sun -rp 1 -a 1
– For NFS, run the command:
racadm autoupdatescheduler create -u nfsadmin -p nfspwd -l 1.2.3.4:/share -f cat.xml -time 14:30 -dom 1 -rp 5 -a 1
– For FTP, run the command:
racadm autoupdatescheduler create -u ftpuser -p ftppwd -l ftp.test.com -f
29
cat.xml.gz -ph 10.20.30.40 -pu padmin -pp ppwd -po 8080 -pt http -time 14:30 -dom 1 ­rp 5 -a 1
– For HTTP, run the command:
racadm autoupdatescheduler create -u httpuser -p httppwd -l http://test.com ­f cat.xml -ph 10.20.30.40 -pu padmin -pp ppwd -po 8080 -pt http -time 14:30 -dom 1 -rp 5 -a 1
– For TFTP, run the command:
racadm autoupdatescheduler create -l tftp://1.2.3.4 -f cat.xml.gz -time 14:30 ­dom 1
-rp 5 -a 1
– To view AutoUpdateScheduler parameter:
racadm autoupdatescheduler view hostname = 192.168.1.1 sharename = nfs sharetype = nfs catalogname = Catlog.xml time = 14:30dayofmonth =1 repeat = 5 applyreboot = 1 idracuser = racuser
– To clear and display AutoUpdateScheduler parameter:
racadm autoupdatescheduler clear RAC1047: Successfully cleared the Automatic Update (autoupdate) feature settings
cd
Descripti on
Synopsis
Input
Output Displays the new prompt.
Example
30
To change the current working object, use this command.
racadm> cd <object>
racadm> cd <object>
Example 1: To navigate to the system device type directory:
racadm>>cd system racadm/system>
Loading...
+ 642 hidden pages