ManualsPro Dell iDRAC9 Integrated Dell Remote Access Controller 9 User Guide

iDRAC9 Integrated Dell Remote Access Controller 9 User Guide

June 14, 2024
Dell

iDRAC9 Integrated Dell Remote Access Controller 9

iDRAC9-Integrated-Dell-Remote-Access-Controller-9

Product Information

Specifications

  • Product Name: Integrated Dell Remote Access Controller 9
  • Model: RACADM CLI Guide
  • Revision: 2023 Rev. A00

Introduction

The Integrated Dell Remote Access Controller 9 (iDRAC9) is a powerful remote management tool for Dell servers. This document provides information about the RACADM subcommands, supported RACADM interfaces, and property database groups and object definitions for iDRAC on Dell servers.

New Features
 The following new features have been added in the firmware releases:

  • Firmware version 6.10.85.00:
    • Support for storage exportcertificate subcommand (PERC 12).
    • Support for detecting SPDM capable devices in the storage controller inventory.
    • RACADM now exports the SPDM certificate in DER format.
  • Firmware version 6.10.80.00:
    • Support for DPU property for systemerase command.
    • Support for -f and –all options for coredumpdelete command.
    • Support for coredumpexport command.
    • Support for sensor readings for OSFP ports in hwinventory.
    • Support to list core files using the coredump command.
    • Support for Critical error and Non-Critical error sensor states for CPU sensor for the getsensorinfo command.
  • Firmware version 6.10.00.00:
    • Support for mounting directories on iDRAC NFS and CIFS shares using Remote File Share (RFS) feature.
    • Support for MemoryTypeExtended property for memory devices (DRAM).
    • Support for IEEE 802.1X based certificates.
    • Support for rebootless updates for NICs that support the PLDM based firmware update (except rNDC and OCP adapters).
    • Support for SSL certificate expiry notification.
    • Support for component hash value in firmware inventory (Redfish and RACADM only).
  • Firmware version 6.00.30.00:
    • Support for Chassis Manager firmware version property for getsysinfo command.
    • Support for enabling/disabling PCIe VDM inventory for specified devices.

Product Usage Instructions

Legacy and New Groups and Objects
 Chapter 4 of the RACADM CLI Guide provides information about legacy and new groups and objects in the property database. It includes details about the cfgSSADRoleGroupPrivilege subcommand, which allows you to set read or write privileges.

Error Codes
 Chapter 5 of the RACADM CLI Guide lists the error codes that may be encountered while using the iDRAC. It provides explanations and troubleshooting steps for each error code.

FAQ

Q: Where can I find the Attribute Registry guide?
 A: The Attribute Registry guide is available at dell.com/support.

Q: How can I determine the most recent firmware release for my platform?
 A: You can refer to the KB article 00178115 available at https://www.dell.com/support/article/sln000178115 for details about the previous releases and to determine the most recent release for your platform.

Integrated Dell Remote Access Controller 9
RACADM CLI Guide
2023 Rev. A00

Notes, cautions, and warnings
NOTE: A NOTE indicates important information that helps you make better use of your product. 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.
© 2023 Dell Inc. or its subsidiaries. All rights reserved. Dell Technologies, Dell, and other trademarks are trademarks of Dell Inc. or its subsidiaries. Other trademarks may be trademarks of their respective owners.

Introduction

This document provides information about the RACADM subcommands, supported RACADM interfaces, and property database groups and object definitions for iDRAC for the Dell servers.
Topics:
· New features added · Deprecated and New Subcommands · Unsupported RACADM Subcommands · Supported RACADM Interfaces · RACADM Syntax Usage · Proxy parameters · Supported Storage Controller cards · Other Documents You May Need · Accessing documents from Dell support site · Contacting Dell
New features added
NOTE: For new attributes added, see the Attribute Registry guide available at dell.com/support
NOTE: For details about the previous releases, if applicable, or to determine the most recent release for your platform, and for latest documentation version, see KB article 00178115 available at https://www.dell.com/support/article/sln000178115 This section provides the list of new features added in the following releases: Firmware version 6.10.85.00 Firmware version 6.10.80.00 Firmware version 6.10.00.00 Firmware version 6.00.30.00 Firmware version 6.00.02.00
Firmware version 6.10.85.00
Following features were added or updated in this release: Support for storage exportcertificate subcommand (PERC 12). Support for detecting SPDM capable devices in the storage controller inventory.
NOTE: RACADM now exports the SPDM certificate in DER format. This may change to PEM format in the future.
Firmware version 6.10.80.00
Following features were added or updated in this release: Support for DPU property for systemerase command. Support for -f and –all options for coredumpdelete command. Support for coredumpexport command. Support for sensor readings for OSFP ports in hwinventory. Support to list core files using the coredump command. Support for “Critical error” and “Non-Critical error” sensor states for CPU sensor for the getsensorinfo command.

6

Introduction

Firmware version 6.10.00.00
Following features were added or updated in this release: Support for mounting directories on iDRAC NFS and CIFS shares using Remote File Share (RFS) feature.
NOTE: This feature is only supported on 15th generation and newer PowerEdge servers.
Support for MemoryTypeExtended property for memory devices (DRAM) . Support for IEEE 802.1X based certificates. Support for rebootless updates for NICs that support the PLDM based firmware update (except rNDC and OCP adapters). Support for SSL certificate expiry notification. Support for component hash value in firmware inventory (Redfish and RACADM only).

Firmware version 6.00.30.00
Following features were added or updated in this release: Support for Chassis Manager firmware version property for getsysinfo command. Support for enabling/disabling PCIe VDM inventory for specified devices.

Firmware version 6.00.02.00
Following features were added or updated in this release: Support for pcieslotview command to display PCIe slot details. Support for attaching second remote image using remoteimage2 command. Support for CPUAffinity (NUMA) property for PCIe devices and GPU cards.

Deprecated and New Subcommands

NOTE: Following commands are deprecated, and will not be available from iDRAC version 4.40.00.00 and onwards. Ensure that
you reconfigure the scripts that use these commands to avoid any issues or failures. WSMan is deprecated, with no further updates or new features to be added.

Table 1. Details of Deprecated and New Subcommands

Deprecated Subcommands

New Subcommands

getconfig

get

config

set

NOTE: Some examples in this document still use getconfig and config subcommands as they still work with previous versions of iDRAC.

getuscversion systemconfig

getversion N/A

Unsupported RACADM Subcommands
The following table provides the list of RACADM subcommands which are not supported through Telnet/SSH/Serial interface of RACADM.

Introduction

7

Table 2. Unsupported RACADM Subcommands

Subcommand

iDRAC on Blade Servers

Telnet/SSH/Serial

krbkeytabupload

No

sslcertupload

No

sslkeyupload

No

usercertupload

No

Supported RACADM Interfaces
The RACADM command-line utility provides a scriptable interface that allows you to locally or remotely configure your iDRAC. The utility runs on the management station and the managed system. The RACADM utility is available on the Dell OpenManage Systems Management and Documentation DVD or at https://www.dell.com/support. 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 https://www.dell.com/support, select Drivers and Downloads, select a server, and then select Systems Management > Dell Toolkit.
NOTE: Local RACADM and local RACADM proxy runs with root user privilege. SSH–Also known as Firmware RACADM. Firmware RACADM is accessible by logging in to iDRAC using SSH. Similar to
Remote 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 an SSH RACADM command.
NOTE: You must have administrator privileges to run RACADM commands using Remote RACADM. ESXi operating system allows up to 1020 characters in a RACADM command. This is limited to local and remote
RACADM interfaces. For more information about the options, see RACADM Subcommand Details. To download the local RACADM tool, go to https://www.dell.com/poweredgemanuals, select the desired server. and then click Drivers & downloads.
RACADM Syntax Usage
The following section describes the syntax usage for SSH and Remote RACADM.
SSH or Remote RACADM
racadm -r -u -p
racadm -r -u -p get -g -o

racadm

8

Introduction

Example racadm getsysinfo racadm -r 192.168.0.2 -u username -p xxx getsysinfo racadm -r 192.168.0.2 -u username -p xxx get -g cfgchassispower

Remote RACADM

NOTE: By default, TLS version 1.0 is enabled on Windows 2012 R2 which is not supported on the Remote RACADM.
Install the latest Windows update available, to upgrade TLS to version 1.1 or higher. Also, set the TLS version in the iDRAC.Webserver.TLSProtocol as appropriate. For more information about Windows update see, support.microsoft.com/en-us/help/3140245/update-to-enable-tls-1-1-and-tls-1-2 -as-default-secure-protocols-in-wi Before configuring the webserver settings to TLS version 1.3, ensure that the client OS supports TLS 1.3. If Force Change of Password (FCP) feature is enabled, it is recommended to change the default password using SSH or iDRAC GUI. Changing the default password using Remote RACADM may not be successful.
racadm -r -u -p
Example
racadm -r 192.168.0.2 -u root -p xxxx getsysinfo Security Alert: Certificate is invalid – Certificate is not signed by Trusted Third Party Continuing execution.

NOTE: The following command does not display a security error:

racadm -r 192.168.0.2 -u noble -p xxx getsysinfo –nocertwarn

The remote RACADM commands must link to the libssl library on the HOST, which corresponds to the version of OpenSSL package installed on the HOST. Perform the following steps to verify and link the library.
Check the openssl version installed in the HOST:

[root@localhost ~]# openssl OpenSSL> version OpenSSL 1.0.1e-fips 11 Feb 2013 OpenSSL>
Locate the openSSL libraries are in the HOST machine (/usr/lib64/ in case of RHEL), and to check the various versions of the libraries: [root@localhost ~]# ls -l /usr/lib64/libssl*

-rwxr-xr-x. 1 root root 249368 Oct 15 2013 /usr/lib64/libssl3.so

lrwxrwxrwx. 1 root root

16 Oct 29 2014 /usr/lib64/libssl.so.10 ->

libssl.so.1.0.1e

-rwxr-xr-x. 1 root root 439912 Sep 27 2013 /usr/lib64/libssl.so.1.0.1e

Link the library libssl.so using ln -s command to the appropriate OpenSSL version in the HOST:

[root@localhost ~]# ln -s /usr/lib64/libssl.so.1.0.1e /usr/lib64/libssl.so Verify if the libssl.so soft linked to libssl.so.1.0.1e: [root@localhost ~]# ls -l /usr/lib64/libssl*

-rwxr-xr-x. 1 root root 249368 Oct 15 2013 /usr/lib64/libssl3.so

lrwxrwxrwx. 1 root root

27 Aug 28 13:31 /usr/lib64/libssl.so -> /usr/lib64/

libssl.so.1.0.1e

lrwxrwxrwx. 1 root root

16 Oct 29 2014 /usr/lib64/libssl.so.10 ->

Introduction

9

libssl.so.1.0.1e -rwxr-xr-x. 1 root root 439912 Sep 27 2013 /usr/lib64/libssl.so.1.0.1e

Accessing Indexed-Based Device Groups and Objects
To access any object, run the following syntax:
device..[].
To display the supported indexes for a specified group, run:
racadm get device.
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..
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...
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:

Table 3. RACADM Command Options Option

Description

-r -r :

Specifies the controller’s remote IP address.
Use if the iDRAC port number is not the default port (443).

-u

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.

10

Introduction

Table 3. RACADM Command Options (continued)

Option

Description

NOTE: If you delete a user account using the iDRAC web interface and then use RACADM to create a new account with the same user name, you are not prompted to enter a password. However, you must manually provide a password for the account to be able to log into iDRAC using that account.

-p –nocertwarn

Specifies the password used to authenticate the command transaction. If the -p option is used, the -i option is not allowed.
Does not display certificate related warning message.

Using autocomplete feature
Use the autocomplete feature in firmware RACADM to:
Display all the available RACADM commands in the alphabetical order by pressing the tab key at the racadm>> prompt. View the complete list, by entering the starting letter of the command at the racadm>> prompt and press tab key.
NOTE:
Commands that are displayed/suggested by the shell are case insensitive.
If an attribute group does not include any attributes, autocomplete does not display this group at all. Navigate the cursor within a command, by pressing:
Home key: Directs to the starting 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 by pressing up and down arrow key. If an attribute value starts with double quotes but does not end with them, the value is still considered and the command
runs successfully. Exit the Autocomplete mode, by entering Quit or Exit
For example:
Example 1: racadm>>
arp autoupdatescheduler clearasrscreen clearpending closessn clrraclog . . . . . . . vflashsd vflashpartition vmdisconnect cd quit
Example 2: racadm>> get
get getled getniccfg getraclog getractime getsel getsensorinfo getssninfo

Introduction

11

getsvctag getsysinfo gettracelog getversion
Example 3:
racadm>> getl
racadm>> getled or LEDState: Not-Blinking
Example 4:
racadm>> get bios.uefiBootSettings BIOS.UefiBootSettings BIOS.UefiBootSettings.UefiBootSeq BIOS.UefiBootSettings.UefiPxeIpVersion
NOTE: In the RACADM autocomplete mode, type the commands directly without giving racadm as prefix. NIC/FC/InfiniBand FQDDs are configuration-dependent. To find FQDDs present in system, run the RACADM command
racadm hwinventory NIC/FC/InfiniBand
Lifecycle Controller Log
Lifecycle Controller logs provide the history of changes related to components installed on a managed system. You can also add work notes to each log entry. The following events and activities are logged: System events Storage devices Network devices Configuration Audit Updates You can view and filter logs based on the category and severity level. You can also export and add a work note to a log event. If you initiate configuration jobs using RACADM CLI or iDRAC web interface, the Lifecycle log captures the information about the user, interface used, and the IP address of the system from which you initiate the job.
Proxy parameters
Some commands do not support setting the proxy parameters if the share location (-l) is HTTP/HTTPS. To perform the operation with HTTP or HTTPS through a proxy, the proxy parameters must be first configured using the lifecyclecontroller.lcattributes. Once these proxy parameters are configured, they become the part of default configuration; the proxy attributes should be cleared to end use of the HTTP/HTTPS proxy. The valid lifecyclecontroller.lcattributes HTTP/HTTPS proxy parameters are:
UserProxyUserName UserProxyPassword UserProxyServer UserProxyPort UserProxyType To view the list of proxy attributes, use racadm get lifecycleController.lcAttributes.

12

Introduction

Supported Storage Controller cards

The following table lists the supported Storage Controller cards:

PERC 11 PERC 10 PERC 9 HBA cards BOSS Cards cards Software RAID

PERC H350, PERC H355, PERC H750, and PERC H755 PERC H345, PERC H740, PERC H740P, PERC H745P, and PERC H840 PERC H330, PERC H730, PERC H730P, PERC H830, PERC FD33xS, and PERC FD33xD HBA 330, HBA 345, HBA 355, HBA 350i and 12Gbps SAS HBA BOSS S1, BOSS S2
PERC S130, PERC S140, PERC S150

Other Documents You May Need
In addition to this guide, you can access the following guides available on the Dell Support website at https://www.dell.com/ idracmanuals. To access the documents, click the appropriate product link.
The Integrated Dell Remote Access Controller 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 iDRAC9 Attribute Registry provides information about all attributes to perform get and set operations using RACADM interface.
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.

Accessing documents from Dell support site
You can access the required documents in one of the following ways: Using the following links:
For all Enterprise Systems Management documents — https://www.dell.com/esmmanuals For OpenManage documents — https://www.dell.com/openmanagemanuals For iDRAC and Lifecycle Controller documents — https://www.dell.com/idracmanuals For OpenManage Connections Enterprise Systems Management documents — https://www.dell.com/
OMConnectionsEnterpriseSystemsManagement For Serviceability Tools documents — https://www.dell.com/serviceabilitytools For Client Command Suite Systems Management documents — https://www.dell.com/omconnectionsclient From the Dell Support site: 1. Go to https://www.dell.com/support.

Introduction

13

2. Under Browse all products section, click Software. 3. In the Software group box, click the required link from the following:
Enterprise Systems Management Client Systems Management Serviceability Tools
4. To view a document, click the required product version.
Using search engines: Type the name and version of the document in the search box.
Contacting Dell
NOTE: If you do not have an active Internet connection, you can find contact information on your purchase invoice, packing slip, bill, or Dell product catalog.
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 https://www.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 bottom of the page. 4. Select the appropriate service or support link based on your need.

Introduction

Running Get and Set

This section provides detailed description of the RACADM Get and Set subcommands including the syntax and valid entries. For more information about all attributes to perform get and set operations, see the Integrated Dell Remote Access Controller Attribute Registry available at https://www.dell.com/idracmanuals
Topics:
· get · set

get

Table 4. Details of get

Description

Displays the value of one or more objects. The get subcommand has two forms.
Displays the value of a single object. Exports the value of multiple objects to a file.
It supports multiple object value exports in the below file format:
Server Configuration Profile(SCP) XML and JSON format–XML and JSON format files can be imported from a local file, from an NFS, CIFS, HTTP, HTTPS, FTP and TFTP network share. NOTE: You need admin user privilege to perform import and export SCP operations.
NOTE: Some objects may have a pending value if a Set operation is performed on the object through
a reboot job. To complete the pending operation, schedule the job using a jobqueue command, and then check for completion of the job using the returned Job ID. For more information, see jobqueue. Import and Export of INI file type doesn’t support -c option for firmware versions earlier than iDRAC version 4.40.00.00. For more information on the get subcommand, run the RACADM command racadm help get Autobackup will return a license error from iDRAC version 4.40.00.00 release for Rx4xx and Mx4xx platforms. The command will display this error as the feature and the corresponding license will be removed. For HddSeq, BootSeq and UefiBootSeq attributes, a maximum of 32 device list is supported. For Unique FQDDs, use the iDRAC Redfish interface.

Synopsis

Single-object Get

racadm get .

racadm get ..

racadm get ..[].

racadm get ....

Running Get and Set

15

Table 4. Details of get (continued)
Multi-object Get
racadm get -f -t xml -l [–clone | –replace ] [–includeph]

racadm get -f -t xml -l -c [,*]

racadm get -f -t xml -u -p -l -c

racadm get -f -t xml -l -c

racadm get -f -t xml -u -p -l [–clone | –replace ] [–includeph]

racadm get -f -t xml -u -p -l -c

[,*]

racadm get -f -t xml -u -p -l -c

racadm get -f -t xml -u -p -l -c

racadm get -f -t xml –customdefaults

racadm get -f -t xml -l [–clone | –replace ] [-includeph] [–includeCustomTelemetry]

racadm get -f -t xml -u -p -l [–clone | –replace ] [-includeph] [–includeCustomTelemetry]

Input

Examples for FQDDs System.Power System.Power.Supply System.Location LifecycleController.LCAttributes System.LCD iDRAC.Serial For the list of supported groups and objects under the get command, see Database objects with get and set commands. –Specifies the group containing the object that must be read. –Specifies the object name of the value that must be read. –Specifies where FQDD Aliases or Groups must be indexed. -f –This option enables you to export multiple object values to a file. This option is not supported in the Firmware RACADM interface. -u–Specifies user name of the remote CIFS share to which the file must be exported. -p–Specifies password for the remote CIFS share to which the file must be exported. -l–Specifies network share location to which the file is exported. -t–Specifies the file type to be exported. The valid values are:

16

Running Get and Set

Table 4. Details of get (continued)
JSON–It exports the SCP JSON file to a network share file. xml–It exports the SCP xml format file, either to a local or network share file. –clone–Gets the configuration .xml files without system-related details such as service tag. The .xml file received does not have any virtual disk creation option. –replace–Gets the configuration .xml files with the system-related details such as service tag. -c–Specifies the FQDD or list of FQDDs separated by ‘,’ of the components for which the configurations should be exported. If this option is not specified, the configuration related to all the components are exported. –includeph–Specifies that the output of the passwords included in the exported configuration .xml file are in the hashed format.
NOTE: if –includeph is not used, the output of the passwords are in the .xml file in clear text.
–customdefaults–Exports custom default configuration to file. Supports only with XML file type and local share.
–includeCustomTelemetry–Includes Telemetry Custom Metric Report Definitions (MRDs) in the configuration XML file.
NOTE:
For –clone and –replace options, only .xml file template is received. These options -clone and –replace cannot be used in the same command.
–customdefaults and –includeCustomTelemetry cannot be used in the same command.
This command does not support proxy parameters. To perform the operation with http and https, the proxy parameters has to be configured in the lifecyclecontroller.lcattributes. Once these proxy parameters are configured, they become the part of default configuration. They have to be removed to ignore the proxy parameters.
This command does not support setting the proxy parameters if the share location (-l) is HTTP/HTTPS. To perform the operation with HTTP or HTTPS through a proxy, the proxy parameters must be first configured using the lifecyclecontroller.lcattributes. Once these proxy parameters are configured, they become the part of default configuration; the proxy attributes should be cleared to end use of the HTTP/ HTTPS proxy.
The valid lifecyclecontroller.lcattributes HTTP/HTTPS proxy parameters are: UserProxyUserName UserProxyPassword UserProxyServer UserProxyPort UserProxyType
To view the list of proxy attributes, use racadm get lifecycleController.lcAttributes.

Examples

Get system LCD information.

racadm get system.lcdLCDUserString Display an entire group, in this case the topology configuration.

racadm get system.location Display a single object from a particular group.

racadm get system.location.rack.name Export the xml configuration to a CIFS share.

racadm get -f file -t xml -u myuser -p xxx -l //192.168.0/share Export the xml configuration to an NFS share.

racadm get -f file -t xml -l 192.168.0:/myshare

Running Get and Set

17

Table 4. Details of get (continued) Export a “cloned” xml configuration to a CIFS share
racadm get -f xyz_temp_clone -t xml -u Administrator -p xxx -l // 192.168.0/xyz –clone Export a “replace” xml configuration to a CIFS share
racadm get -f xyz_temp_replace -t xml -u Administrator -p xxx -l // 192.168.0/xyz –replace Export the xml configuration of the iDRAC component to FTP share.
racadm get -f file -t xml -u username -p password -l ftp:// 192.168.10.24/ Export the JSON configuration of the iDRAC component to FTP share.
racadm get -f file -t json -u username -p password -l ftp:// 192.168.10.24/ Export the xml configuration of the iDRAC component to TFTP share.
racadm get -f file -t xml -l tftp://192.168.10.24/ Export the JSON configuration of the iDRAC component to TFTP share.
racadm get -f file -t json -l ftp://192.168.10.24/ Export the xml configuration of the iDRAC component to a CIFS share.
racadm get -f file -t xml -u myuser -p xxx -l //192.168.0/share -c iDRAC.Embedded.1 Export the xml configuration of the iDRAC component to NFS share.
racadm get -f file -t xml -l 10.1.12.13:/myshare Export the xml configuration of the iDRAC component to HTTP share.
racadm get -f file -t xml -u httpuser -p httppwd -l http://test.com/ myshare Export the xml configuration of the iDRAC component to HTTPS share.
racadm get -f file -t xml -u httpuser -p httppwd -l https://test.com/ myshare Export the JSON configuration of the iDRAC component to HTTP share.
racadm get -f file -t json -u httpuser -p httppwd -l http://test.com/ myshare Export the JSON configuration of the iDRAC component to HTTPS share.
racadm get -f file -t json -u httpuser -p httppwd -l https://test.com/ myshare Export the custom default xml configuration to local share.
racadm get -f file -t xml –customdefaults Include Telemetry Custom Metric Report Definitions in the configuration .xml file.
racadm get -f -t xml -l -u -p

–includeCustomTelemetry

18

Running Get and Set

Table 4. Details of get (continued) Include password hash in the configuration .xml file. racadm get -f -t xml -l -u -p -t xml –includeph Configure proxy parameters. racadm set lifecyclecontroller.lcattributes.UserProxyUsername admin1
racadm set lifecyclecontroller.lcattributes.UserProxyUsername View the list of proxy attributes.
racadm get lifecycleController.lcAttributes To display InfiniBand related groups.
racadm get InfiniBand

set

Table 5. Details of set

Description

Modifies the value of configuration objects on a component. The Set sub- command has two forms:
The modification of a single object to a new value specified in the command line. The modification of multiple objects to new values using a configuration file.
It supports multi-object value import from the below configuration file format:
Server Configuration Profile(SCP) XML and JSON format–XML and JSON format files can be imported from a local file, from an NFS, CIFS, HTTP, HTTPS, FTP and TFTP network share. NOTE: You need admin user privilege to perform import and export SCP operations.

Depending on the type of configuration object being modified, the new values could be applied immediately (in “real-time”) or require staging and a reboot of the system to apply the new values. The following components support either real-time or staged application of new values:
iDRAC with Lifecycle Controller PowerEdge RAID controllers
NOTE: Use PowerEdge RAID controllers with firmware version 9.1 or later. The real-time support is provided only while performing hardware RAID configuration.
The following components require staging and system reboot for application of new values:
BIOS Other PowerEdge RAID controllers — For software RAID configuration Networking devices ­ Ethernet and Fibre Channel
NOTE:
To modify the value of staged objects such as BIOS or NIC, commit and reboot job creation must be used to apply the pending values. When single object Setoperations are used to stage value modification, use the jobqueue command to schedule a job to reboot the server and apply the new values. For staged multi-object Setoperations using xml configuration files, a job will automatically be created by the Set command; use the ­b, -w and -s options to specify how the staged reboot will be performed. For more information, see jobqueue.
Import and Export of INI file type doesn’t support -c option for firmware versions earlier than iDRAC 4.40.00.00.
For more information on the set subcommand, run the RACADM command racadm help set.

Synopsis

Single-object Set

Running Get and Set

19

Table 5. Details of set (continued)

racadm set .

racadm set ..

racadm set ..[].

racadm set .... Multi-object Set racadm set -f -t xml -l [–preview] [–continue]

racadm set -f -t xml -l -c [,*]

racadm set -f -t xml -u -p -l [–preview] [–continue]

racadm set -f -t xml -u -p -l -c

[,*]

racadm set -f -t -u -p -l [-s

] [-c ] [–preview] [-customdefaults]

racadm set –savecustomdefaults Configure a RAC from an XML configuration file located on a remote NFS share
racadm set -f -t xml -l 10.1.2.3:/myshare Configure a RAC from an XML configuration file located on a remote HTTP share.
racadm set -f -t xml -u -p -l http://test.com/myshare Configure a RAC from an XML configuration file located on a remote HTTPS share.
racadm set -f -t xml -u -p -l https://test.com/myshare Configure a RAC from an XML configuration file located on a remote FTP share
racadm set -f -t xml -u -p -l -c

Configure a RAC from an XML configuration file located on a remote TFTP share. racadm set -f -t xml -l -c To modify the value of InfiniBand attribute racadm set

Input

Examples for FQDDs: System.Power System.Power.Supply System.Location LifecycleController.LCAttributes System.LCD iDRAC.Serial — Specifies the group containing the object that must be written.

20

Running Get and Set

Table 5. Details of set (continued)

— Specifies the object name of the value that must be written. — This option is specified where FQDD Aliases or Groups must be indexed. -f — Enables set to configure the device from a specified file. This option is not supported in the Firmware RACADM interface. -u — Specifies user name of the CIFS remote share from which the file must be imported -p — Specifies password for the remote CIFS share from which the file must be imported. -l — Specifies network share location from where the file must be imported. -t — Specifies the file type to be imported. The valid values are: xml–Imports the Server Configuration Profile in XML format either from a local or network share file. JSON–Specifies a JSON file. Staging and reboot control options The following options control when and how system reboots are performed when using the ­f option. As noted above, some FQDDs require a system reboot to apply the new values; other FQDDs optionally support immediate application of new values. If the imported file contains ONLY immediate application-capable FQDDs such as iDRAC, do NOT use the ­b option and the Set command will schedule a real-time job to immediately apply the new values. NOTE: The ­b, -w, ­s, and –preview options are applicable only with ­f option. -b–Specifies the host shutdown type to run scheduled import job. The parameters are Graceful, Forced, and NoReboot for graceful shutdown, forced shutdown, and no reboot respectively. If -b is not specified, graceful shutdown is taken as the default except as noted above for files containing new values for immediate application-capable s. NOTE: If the operating system is in use, then the graceful shutdown option may time out within 300 seconds. If this operation is unsuccessful, then retry with the force option. -w–Maximum time to wait for the graceful shutdown to occur. The value must be entered in seconds. Minimum accepted value is 300 seconds and the maximum accepted value is 3600 seconds. The default value is 1800 seconds. -s–Power state of the host when the import operation completes. The parameters are “On” for powered ON and “Off” for powered OFF. If this parameter is not specified, power ON is taken as default. –preview–Validates the configuration .xml file and view the status. The –preview option provides the Job ID to verify the status of the file preview operation. The Job ID can be tracked by running the racadm jobqueue view ­I command. NOTE: The –preview option does not restart the system. The-b,-w options cannot be included with the –preview option. A scheduled job or pending configuration should not be running while using the –preview option. -c–Specifies the FQDD or list of FQDDs separated by ‘,’ of the components for which the configurations should be imported. If this option is not specified, configuration related to all the components are imported. NOTE: To use the -c or –preview option, the minimum Lifecycle Controller version required is 1.2. On certain devices, importing the server configuration profile requires two imports to apply the configuration to all the devices. The first import of the profile enables hidden devices which are then configured with a second import. The devices that require two imports are as follows: PERC S110 and PERC S130 controllers PERC S110 and PERC S130 controllers BIOS and PCIe device: enabling PCIe slots in the system that are disabled and configuring the PCIe device

Running Get and Set

21

Table 5. Details of set (continued)
BIOS: enabling processor trusted execution (TXT) when server has Trusted Platform Module (TPM) 2.0 installed
BIOS: if SCP contains only a BIOS section that includes switching boot mode to UEFI and configuration of UEFI PXE network settings
BIOS: if SCP contains only a BIOS section that includes switching boot mode to legacy BIOS or UEFI along with changes to the boot order sequence using changes to BootSeq, HddSeq, or UefiBootSeq attributes.
BIOS: changing TPM 2.0 cryptographic support from the default of SHA-1 NOTE: Boot mode and boot order sequence can be changed with a single SCP import if the SetBootOrderFqddN and SetLegacyHddOrderFqddN attributes are used.
–savecustomdefaults–Saves current configuration as custom default configuration. –customdefaults–Performs the upload of custom default configuration file. This option
should not be combined with –preview. Supports XML file type only.
This command does not support setting the proxy parameters if the share location (-l) is HTTP/HTTPS. For more information, see Proxy parameter section.

Example

Single-object Set of real-time objects Configure LCD String.

racadm set system.lcd.LCDUserString test
Configure iDRAC name. racadm set iDRAC.Info.Name idrac-server100
Single-object Set of staged objects
Configure several BIOS settings, create a job to initiate application of new values, reboot the system, then wait for the job to complete.
racadm set BIOS.SysProfileSettings.ProcTurboMode Disabled racadm set BIOS.ProcSettings.ProcVirtualization Enabled racadm set BIOS.ProcSettings.ControlledTurbo Enabled racadm jobqueue create BIOS.Setup.1-1 ­r Graceful
Note of the Job ID output by the jobqueue command After reboot, wait for the job to complete by checking the job status
racadm jobqueue view ­i
Multi-object Set of real-time objects
Configure the iDRAC using a local Server Configuration Profile XML file containing only iDRAC settings.
racadm set -f myidrac.xml -t xml Configure the iDRAC using a Server Configuration Profile XML file stored on an NFS share containing
only iDRAC settings.
racadm set -f myidrac.xml -t xml -l 10.1.2.3:/myshare Import a Server Configuration Profile from a CIFS share, using only the iDRAC component.
racadm set -f file ­t xml -u myuser -p mypassword -l //192.168.0/share -c iDRAC.Embedded.1
Multi-object Set of staged objects
Configure a systems using a local Server Configuration Profile XML file containing a mix of real-time and staged objects; reboot the server gracefully with a wait time of ten minutes, leaving the server powered on after the reboot.
racadm set -f myfile.xml -t xml -b “graceful” -w 600 -s “on”
Make note of the Job ID output by the Set command. After reboot, wait for the job to complete by checking the job status.

22

Running Get and Set

Table 5. Details of set (continued) racadm jobqueue view ­i
Configure a systems using a local Server Configuration Profile XML file containing a mix of real-time and staged objects; postpone reboot until other operations have been completed. racadm set -f myfile.xml -t xml -b NoReboot
Make note of the Job ID output by the Set command; because of the NoReboot option, the job will be pending until the server is rebooted
Complete other operations, then perform a reboot After reboot, wait for the job to complete by checking the job status
racadm jobqueue view ­i Verify the Server Configuration Profile XML file content located in a remote CIFS share.
racadm set -f temp_Configuration_file -t xml -u Administrator -p Password -l //192.168.0/xyz ­preview Configure a RAC from an XML configuration file located on a remote FTP share.
racadm set -f myfile.xml -t xml -u username -p password -l ftp:// 192.168.10.24/ Configure a RAC from a JSON configuration file located on a remote FTP share.
racadm set -f myfile.xml -t json -u httpsuser -p httpspwd -l ftp:// 192.168.10.24/ Configure a RAC from an XML configuration file located on a remote TFTP share.
racadm set -f myfile.xml -t xml -l tftp://192.168.10.24/ Configure a RAC from a JSON configuration file located on a remote TFTP share.
racadm set -f myfile.xml -t json -l tftp://192.168.10.24/ Configure a RAC from an XML configuration file located on a remote HTTP share.
racadm set -f myfile.xml -t xml -u httpuser -p httppwd -l http:// test.com/myshare Configure a RAC from an XML configuration file located on a remote HTTPS share.
racadm set -f myfile.xml -t xml -u httpsuser -p httpspwd -l https:// test.com/myshare Configure a RAC from a JSON configuration file located on a remote HTTPS share.
racadm set -f myfile.xml -t json -u httpsuser -p httpspwd -l https:// test.com/myshare Configure the proxy parameter.
racadm set lifecyclecontroller.lcattributes.UserProxyUsername admin1 Remove the proxy parameter.
racadm set lifecyclecontroller.lcattributes.UserProxyUsername Upload the custom default XML configuration file located on NFS share to RAC.
racadm set -f myfile.xml -t xml -l share_ip:/PATH –customdefaults Save current configuration as custom default configuration.
racadm set –savecustomdefaults

Running Get and Set

23

3
RACADM Subcommand Details
This section provides detailed description of the RACADM subcommands including the syntax and valid entries.
Topics:
· Guidelines to Quote Strings Containing Special Characters When Using RACADM Commands · help and help subcommand · ackdriveremoval · arp · autoupdatescheduler · bioscert · biosscan · cd · clearasrscreen · clearpending · closessn · clrsel · cmreset · connect · coredump · coredumpdelete · coredumpexport · diagnostics · driverpack · eventfilters · exposeisminstallertohost · fcstatistics · frontpanelerror · fwupdate · gethostnetworkinterfaces · getled · getniccfg · getraclog · getractime · getremoteservicesstatus · getsel · getsensorinfo · getssninfo · getsvctag · getsysinfo · gettracelog · getversion · groupmanager · httpsbootcert · hwinventory · ifconfig · iLKM · infinibandstatistics · inlettemphistory · jobqueue · krbkeytabupload

24

RACADM Subcommand Details

· lclog · license · netstat · networktransceiverstatistics · nicstatistics · pcieslotview · ping · ping6 · plugin · racadm proxy · racdump · racreset · racresetcfg · recover · remoteimage · remoteimage2 · rollback · SEKM · serialcapture · sensorsettings · serveraction · setled · setniccfg · sshpkauth · sslcertdelete · sslcertdownload · sslcertupload · sslcertview · sslcsrgen · sslkeyupload · sslresetcfg · storage · supportassist · swinventory · switchconnection · systemerase · systemperfstatistics · techsupreport · testalert · testemail · testrsyslogconnection · testtrap · traceroute · traceroute6 · update · usercertupload · usercertview · vflashpartition · vflashsd · vmdisconnect · witnessnodepoweraction

RACADM Subcommand Details

25

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 quotation marks) (backward quotation marks) (backward slash) ~ (tilde) | (vertical bar) ( (left parentheses) ) (right parentheses) & (ampersand) > (greater than) < (less than) # (pound) ASCII code 32 (space) There are different escaping rules for double quotation marks. For using double quotation marks: The following characters must be escaped by preceding with a backward slash: $ (dollar sign) ” (double quotation marks) (back quotation marks) ‘ (single quotation marks)

help and help subcommand

Table 6. help and help subcommand

Description

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.

Synopsis Input
Output

racadm help racadm help

— specifies the subcommand for which you need the help information. — specifies the device name such as iDRAC, BIOS, NIC, LifecycleController, FC, system, or Storage. — specifies the group name supported by the corresponding device. — specifies the object for the entered group. The help command displays a complete list of subcommands. The racadm help command displays information for the specified subcommand only. The racadm help command displays information for the specified group. The racadm help command displays information for the specified object. NOTE: help for NIC/FC/Infiniband vendor implementation specific attributes are fetched from the respective vendors and may not be complete for few attributes.

26

RACADM Subcommand Details

Table 6. help and help subcommand (continued)

Example

To display the help information about InfiniBand FQDD:

racadm help

ackdriveremoval

Table 7. Details of RACADM Ackdriveremoval

Description

The plugin subcommand acknowledges drive removal and clears the amber state of the chassis LED to healthy state.

Synopsis

racadm ackdriveremoval -d -b racadm ackdriveremoval –all

Input Example

–all–Acknowledge all the drive removal. -d–Drive ID to acknowledge drive removal. -b–Bay ID to acknowledge drive removal.
To acknowledge all the drive removal:

racadm ackdriveremoval –all

To acknowledge the drive removal for a given drive and bay id:

racadm ackdriveremoval -d 2 -b 0

arp

Table 8. Details of arp sub command

Description

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.

Synopsis

racadm arp

Input Example

N/A racadm arp

Output

Table 9. Details of output

Address

HW Type

192.168.1.1

Ether

HW Address

Mask

00:0d:65:f3:7c:bf C

Device eth0

autoupdatescheduler

Table 10. Details of the autoupdatescheduler command

Description

You can automatically update the firmware of the devices on the server.

RACADM Subcommand Details

27

Table 10. Details of the autoupdatescheduler command (continued)
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. 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 -p -l -f

-time