Back to Contents Page

Using the RACADM Command Line Interface

Integrated Dell™ Remote Access Controller 6 (iDRAC6) Enterprise for Blade Servers Version 2.2 User Guide

  RACADM Subcommands

  Supported RACADM Interfaces

  Using local RACADM Commands

  Using the RACADM Utility to Configure iDRAC6

  Remote and SSH/Telnet RACADM

  Using an iDRAC6 Configuration File

  Configuring Multiple iDRAC6s

The RACADM command line interface (CLI) provides access to iDRAC6 management features on the managed server. RACADM provides access to most of the features on iDRAC6 Web interface. RACADM can be used in scripts to ease configuration of multiple servers, instead of using the Web interface, which, is more useful for interactive management.

The following interfaces are available for RACADM:

• Local RACADM
  
  
• Remote RACADM
  
  
• Telnet/SSH RACADM
  
  

Local RACADM commands do not use network connections to access iDRAC6 from the managed server. This means that you can use local RACADM commands to configure the initial iDRAC6 networking. Remote RACADM is a client side utility, which can be executed from a management station through the out of band network interface. SSH/Telnet RACADM is used to refer to the RACADM command usage from a SSH or Telnet prompt.

This section provides the following information:

• RACADM commands and supported RACADM interfaces
  
  
• Using local RACADM from a command prompt
  
  
• Remote RACADM
  
  
• SSH/Telnet RACADM
  
  
• Configuring iDRAC6 using the racadm command
  
  
• Using the RACADM configuration file to configure multiple iDRAC6s
  
  

CAUTION: The latest iDRAC6 firmware supports only the latest RACADM version. You may encounter errors if you use an older version of RACADM to query iDRAC6 with the latest firmware. Install the RACADM version shipped with your latest Dell™ OpenManage™ DVD media.

RACADM Subcommands

Table 14-1 provides a description of each RACADM subcommand that you can run in RACADM. For a detailed listing of RACADM subcommands including syntax and valid entries, see "RACADM Subcommand Overview."

Table 14-1. RACADM Subcommands 

Supported RACADM Interfaces

Table 14-2 provides an overview of RACADM subcommands and their corresponding interface support.

Table 14-2. RACADM Subcommand Interface Support 

Using local RACADM Commands

You run RACADM commands locally (on the managed server) from a command prompt or shell prompt.

Log in to the managed server, start a command shell, and enter local RACADM commands in one of the following formats:

• racadm <subcommand> [parameters]
  
  
• racadm <getconfig|config> [-g <group>] [-o <object> <value>]
  
  

Without options, the RACADM command displays general use information. To display the RACADM subcommand list, enter:

racadm help

or

racadm getconfig -h

The subcommand list includes all RACADM commands that are supported by iDRAC6.

To get help for a subcommand, enter:

racadm help <subcommand>

The command displays the syntax and command-line options for the subcommand.

Using the RACADM Utility to Configure iDRAC6

This section describes how to use RACADM to perform various iDRAC6 configuration tasks.

Displaying Current iDRAC6 Settings

The RACADM getconfig subcommand retrieves current configuration settings from iDRAC6. The configuration values are organized into groups containing one or more objects, and the objects have values.

See "iDRAC6 Enterprise Property Database Group and Object Definitions" for a complete description of the groups and objects.

To display a list of all iDRAC6 groups, enter this command:

racadm getconfig -h

To display the objects and values for a particular group, enter this command:

racadm getconfig -g <group>

For example, to display a list of all cfgLanNetworking group object settings, enter the following command:

racadm getconfig -g cfgLanNetworking

Managing iDRAC6 Users with RACADM

NOTE: Use caution when using the racresetcfg command, as all configuration parameters are reset to the original defaults. Any previous changes are lost.

NOTE: If you are configuring a new iDRAC6 or if you ran the racadm racresetcfg command, the only current user is root with the password calvin.

NOTE: Users can be enabled and disabled over time. As a result, a user may have a different index number on each iDRAC6.

NOTE: Users and groups created for Active Directory environments must conform to the Active Directory naming convention.

You can configure up to 15 users in iDRAC6 property database. (A sixteenth user is reserved for the IPMI LAN user.) Before you manually enable an iDRAC6 user, verify if any current users exist.

To verify if a user exists, enter the following command at the command prompt:

racadm getconfig -u <username>

OR

enter the following command once for each index from 1 to 16:

racadm getconfig -g cfgUserAdmin -i <index>

NOTE: You can also enter racadm getconfig -f <filename> and view the generated <filename> file, which includes all users, as well as all other iDRAC6 configuration parameters.

Several parameters and object IDs are displayed with their current values. Two objects of interest are:

# cfgUserAdminIndex=nn

cfgUserAdminUserName=

If the cfgUserAdminUserName object has no value, that index number, which is indicated by the cfgUserAdminIndex object, is available for use. If a name appears after the =, that index is assigned to that user name.

NOTE: Users and groups created for Active Directory environments must conform to the Active Directory naming convention.

Adding an iDRAC6 User

To add a new user to iDRAC6, perform the following steps:

1. Set the user name.
   
   
2. Set the password.
   
   
3. Set the Login to iDRAC6 user privilege.
   
   
4. Enable the user.
   
   

Example

The following example describes how to add a new user named "John" with a "123456" password and login privileges to iDRAC6:

racadm config -g cfgUserAdmin -o cfgUserAdminUserName -i 2 john

racadm config -g cfgUserAdmin -o cfgUserAdminPassword -i 2 123456

racadm config -g cfgUserAdmin -o cfgUserAdminPrivilege -i 2 0x00000001

racadm config -g cfgUserAdmin -o cfgUserAdminEnable -i 2 1

To verify the new user, use one of the following commands:

racadm getconfig -u john

racadm getconfig –g cfgUserAdmin –i 2

Enabling an iDRAC6 User With Permissions

To grant a user a specific administrative (role-based) permissions, set the cfgUserAdminPrivilege property to a bitmask constructed from the values show in Table 14-3:

Table 14-3. Bit Masks for User Privileges 

For example, to allow the user Configure iDRAC6, Configure Users, Clear Logs, and Access Console Redirection privileges, add the values 0x00000002, 0x00000004, 0x00000008, and 0x00000010 to construct the bitmap 0x0000002E. Then enter the following command to set the privilege:

racadm config -g cfgUserAdmin -o cfgUserAdminPrivilege -i 2 0x0000002E

Uploading, Viewing, and Deleting SSH Keys Using RACADM

Upload

The upload mode allows you to upload a keyfile or to copy the key text on the command line. You cannot upload and copy a key at the same time.

From local RACADM:

racadm sshpkauth -i <2 to 16> -k <1 to 4> -f <filename>

From telnet/ssh RACADM:

racadm sshpkauth -i <2 to 16> -k <1 to 4> -t

<key-text>

Example:

Upload a valid key to iDRAC6 User 2 in the first key space using a file:

$ racadm sshpkauth -i 2 -k 1 -f pkkey.key

PK SSH Authentication Key file successfully uploaded to the RAC.

CAUTION: The "file" option is not supported on telnet/ssh/serial RACADM.

View

The view mode allows the user to view a key specified by the user or all keys.

racadm sshpkauth -i <2 to 16> -v -k <1 to 4>

racadm sshpkauth -i <2 to 16> -v -k all

Delete

The delete mode allows the user to delete a key specified by the user or all keys.

racadm sshpkauth -i <2 to 16> -d -k <1 to 4>

racadm sshpkauth -i <2 to 16> -d -k all

CAUTION: The capability to upload, view, and/ or delete SSH keys is based on the "Configure Users" user privilege. This privilege allows user(s) to configure any other user's SSH key. Given the importance of SSH Keys, control the granting of this privilege very carefully.

See "sshpkauth" for information on the subcommand options.

Removing an iDRAC6 User

When using RACADM, users must be disabled manually and on an individual basis. Users cannot be deleted by using a configuration file.

The following example illustrates the command syntax that can be used to delete a RAC user:

racadm config -g cfgUserAdmin -o cfgUserAdminUserName -i <index> ""

A null string of double quote characters ("") instructs iDRAC6 to remove the user configuration at the specified index and reset the user configuration to the original factory defaults.

Testing E-mail Alerting

iDRAC6 e-mail alert feature allows users to receive e-mail alerts when a critical event occurs on the managed server. The following example shows how to test the e-mail alert feature to ensure that iDRAC6 can properly send e-mail alerts across the network.

racadm testemail -i 2

(-i 2 is for the index entry #2 in the e–mail alert table)

NOTE: Ensure that the SMTP and E-mail Alert settings are configured before testing the e-mail alert feature. See "Configuring E-Mail Alerts" for more information.

Testing iDRAC6 SNMP Trap Alert Feature

iDRAC6 SNMP trap alerting feature allows SNMP trap listener configurations to receive traps for system events that occur on the managed server.

The following example shows how a user can test the SNMP trap alert feature.

racadm testtrap -i 2

(-i 2 is for the index entry #2 in the e–mail alert table)

NOTE: Before you test iDRAC6 SNMP trap alerting feature, ensure that the SNMP and trap settings are configured correctly. See the testtrap and testemail subcommand descriptions to configure these settings. See "Configuring Platform Event Traps (PET)" for more information.

Configuring iDRAC6 Network Properties

To generate a list of available network properties, enter the following:

racadm getconfig -g cfgLanNetworking

To use DHCP to obtain an IP address, use the following command to write the object cfgNicUseDhcp and enable this feature:

racadm config -g cfgLanNetworking -o cfgNicUseDHCP 1

The commands provide the same configuration functionality as iDRAC6 Configuration Utility when you are prompted to press <Ctrl><E>. For more information about configuring network properties with iDRAC6 Configuration Utility, see "iDRAC6 LAN."

The following is an example of how the command may be used to configure desired LAN network properties.

racadm config -g cfgLanNetworking -o cfgNicEnable 1

racadm config -g cfgLanNetworking -o cfgNicIpAddress 192.168.0.120

racadm config -g cfgLanNetworking -o cfgNicNetmask 255.255.255.0

racadm config -g cfgLanNetworking -o cfgNicGateway 192.168.0.120

racadm config -g cfgLanNetworking -o cfgNicUseDHCP 0

racadm config -g cfgLanNetworking -o cfgDNSServersFromDHCP 0

racadm config -g cfgLanNetworking -o cfgDNSServer1 192.168.0.5

racadm config -g cfgLanNetworking -o cfgDNSServer2 192.168.0.6

racadm config -g cfgLanNetworking -o cfgDNSRegisterRac 1

racadm config -g cfgLanNetworking -o cfgDNSRacName RAC-EK00002

racadm config -g cfgLanNetworking -o cfgDNSDomainNameFromDHCP 0

racadm config -g cfgLanNetworking -o cfgDNSDomainName MYDOMAIN

NOTE: If cfgNicEnable is set to 0, iDRAC6 LAN is disabled even if DHCP is enabled.

Configuring IPMI Over LAN

1. Configure IPMI over LAN by entering the following command:
   
   

racadm config -g cfgIpmiLan -o cfgIpmiLanEnable 1

NOTE: This setting determines the IPMI commands that can be executed from the IPMI over LAN interface. For more information, see the IPMI 2.0 specifications.

1. Update the IPMI channel privileges by entering the following command:
   
   

racadm config -g cfgIpmiLan -o cfgIpmiLanPrivilegeLimit <level>

where <level> is one of the following:

• 2 (User)
  
  
• 3 (Operator)
  
  
• 4 (Administrator)
  
  

For example, to set the IPMI LAN channel privilege to 2 (User), enter the following command:

racadm config -g cfgIpmiLan -o cfgIpmiLanPrivilegeLimit 2

2. Set the IPMI LAN channel encryption key, if required, using a command such as the following:
   
   

NOTE: iDRAC6 IPMI supports the RMCP+ protocol. See the IPMI 2.0 specifications for more information.

racadm config -g cfgIpmiLan -o cfgIpmiEncryptionKey <key>

where <key> is a 20-character encryption key in a valid hexadecimal format.

2. Configure IPMI Serial over LAN (SOL) using the following command:
   
   

racadm config -g cfgIpmiSol -o cfgIpmiSolEnable 1

NOTE: The IPMI SOL minimum privilege level determines the minimum privilege required to activate IPMI SOL. For more information, see the IPMI 2.0 specification.

1. Update the IPMI SOL minimum privilege level using the following command:
   
   

racadm config -g cfgIpmiSol -o cfgIpmiSolMinPrivilege <level>

where <level> is one of the following:

• 2 (User)
  
  
• 3 (Operator)
  
  
• 4 (Administrator)
  
  

For example, to configure the IPMI privileges to 2 (User), enter the following command:

racadm config -g cfgIpmiSol -o cfgIpmiSolMinPrivilege 2

NOTE: To redirect the serial console over LAN, ensure that the SOL baud rate is identical to your managed server's baud rate.

2. Update the IPMI SOL baud rate using the following command:
   
   

racadm config -g cfgIpmiSol -o cfgIpmiSolBaudRate <baud-rate>

where <baud-rate> is 19200, 57600, or 115200 bps.

For example:

racadm config -g cfgIpmiSol -o cfgIpmiSolBaudRate 57600

3. Enable SOL by typing the following command at the command prompt.
   
   

NOTE: SOL can be enabled or disabled for each individual user.

racadm config -g cfgUserAdmin -o cfgUserAdminSolEnable 1 -i <id>

where <id> is the user's unique ID.

Configuring PEF

You can configure the action you wish iDRAC6 to take for each platform alert. Table 14-4 lists the possible actions and the value to identify them in RACADM.

Table 14-4. Platform Event Action  

Configure PEF actions using the following command:

racadm config -g cfgIpmiPef -o cfgIpmiPefAction -i <index> <action-value>

where <index> is the PEF index (Table 5-8), and <action-value> is a value from Table 14-4.

For example, to enable PEF to reboot the system and send an IPMI alert when a processor critical event is detected, enter the following command:

racadm config -g cfgIpmiPef -o cfgIpmiPefAction -i 9 2

Configuring PET

1. Enable global alerts using the following command:
   
   

racadm config -g cfgIpmiLan -o cfgIpmiLanAlertEnable 1

2. Enable PET using the following command:
   
   

racadm config -g cfgIpmiPet -o cfgIpmiPetAlertEnable -i <index> <0|1>

where <index> is the PET destination index and 0 or 1 disable PET or enable PET, respectively.

For example, to enable PET with index 4, enter the following command:

racadm config -g cfgIpmiPet -o cfgIpmiPetAlertEnable -i 4 1

3. Configure your PET policy using the following command:
   
   

racadm config -g cfgIpmiPet -o cfgIpmiPetAlertDestIPAddr -i <index> <IP-address>

where <index> is the PET destination index and <IP-address> is the destination IP address of the system that receives the platform event alerts.

4. Configure the Community Name string.
   
   

At the command prompt, enter:

racadm config -g cfgIpmiLan -o cfgIpmiPetCommunityName <name>

where <name> is the PET Community Name.

Configuring E-mail Alerts

1. Enable global alerts by entering the following command:
   
   

racadm config -g cfgIpmiLan -o cfgIpmiLanAlertEnable 1

2. Enable e-mail alerts by entering the following commands:
   
   

racadm config -g cfgEmailAlert -o cfgEmailAlertEnable -i <index> <0|1>

where <index> is the e-mail destination index and 0 disables the e-mail alert or 1 enables the alert. The e-mail destination index can be a value from 1 through 4.

For example, to enable e-mail with index 4, enter the following command:

racadm config -g cfgEmailAlert -o cfgEmailAlertEnable -i 4 1

3. Configure your e-mail settings by entering the following command:
   
   

racadm config -g cfgEmailAlert -o cfgEmailAlertAddress -i 1 <email-address>

where 1 is the e-mail destination index and <email-address> is the destination e-mail address that receives the platform event alerts.

4. To configure the SMTP e–mail server, enter the following command:
   
   

racadm config -g cfgRemoteHosts -o cfgRhostsSmtpServerIpAddr <SMTP E-mail Server IP Address>

5. To configure a custom message, enter the following command:
   
   

racadm config -g cfgEmailAlert -o cfgEmailAlertCustomMsg -i <index> <custom-message>

where <index> is the e-mail destination index and <custom-message> is the custom message.

6. Test the configured e-mail alert, if desired, by entering the following command:
   
   

racadm testemail -i <index>

where <index> is the e-mail destination index to test.

Configuring IP Filtering (IP Range)

IP address filtering (or IP Range Checking) allows iDRAC6 access only from clients or management workstations whose IP addresses are within a user-specified range. All other login requests are denied.

IP filtering compares the IP address of an incoming login to the IP address range that is specified in the following cfgRacTuning properties:

• cfgRacTuneIpRangeAddr
  
  
• cfgRacTuneIpRangeMask
  
  

The cfgRacTuneIpRangeMask property is applied to both the incoming IP address and to the cfgRacTuneIpRangeAddr properties. If the results are identical, the incoming login request is allowed to access iDRAC6. Logins from IP addresses outside this range receive an error.

The login proceeds if the following expression equals zero:

cfgRacTuneIpRangeMask & (<incoming-IP-address> ^ cfgRacTuneIpRangeAddr)

where & is the bitwise AND of the quantities and ^ is the bitwise exclusive-OR.

See "cfgRacTuning" for a complete list of cfgRacTuning properties.

Table 14-5. IP Address Filtering (IPRange) Properties 

Following are examples using local RACADM to set up IP filtering.

NOTE: See "Using the RACADM Command Line Interface" for more information about RACADM and RACADM commands.

1. The following RACADM commands block all IP addresses except 192.168.0.57:
   
   

racadm config -g cfgRacTuning -o cfgRacTuneIpRangeEnable 1

racadm config -g cfgRacTuning -o cfgRacTuneIpRangeAddr 192.168.0.57

racadm config -g cfgRacTuning -o cfgRacTuneIpRangeMask 255.255.255.255

2. To restrict logins to a small set of four adjacent IP addresses (for example, 192.168.0.212 through 192.168.0.215), select all but the lowest two bits in the mask, as shown below:
   
   

racadm config -g cfgRacTuning -o cfgRacTuneIpRangeEnable 1

racadm config -g cfgRacTuning -o cfgRacTuneIpRangeAddr 192.168.0.212

racadm config -g cfgRacTuning -o cfgRacTuneIpRangeMask 255.255.255.252

The last byte of the range mask is set to 252, the decimal equivalent of 11111100b.

IP Filtering Guidelines

Use the following guidelines when enabling IP filtering:

• Ensure that cfgRacTuneIpRangeMask is configured in the form of a netmask, where all most significant bits are 1's (which defines the subnet in the mask) with a transition to all 0's in the low-order bits.
  
  
• Use the desired range's base address as the value of cfgRacTuneIpRangeAddr. The 32-bit binary value of this address should have zeros in all the low-order bits where there are zeros in the mask.
  
  

Configuring IP Blocking

IP blocking dynamically determines when excessive login failures occur from a particular IP address and blocks (or prevents) the address from logging in to iDRAC6 for a preselected time span.

The IP blocking features include:

• The number of allowed login failures (cfgRacTuneIpBlkFailcount)
  
  
• The time frame in seconds during which these failures must occur (cfgRacTuneIpBlkFailWindow)
  
  
• The amount of time in seconds that the blocked IP address is prevented from establishing a session after the allowed number of failures is exceeded (cfgRacTuneIpBlkPenaltyTime)
  
  

As login failures accumulate from a specific IP address, they are registered by an internal counter. When the user logs in successfully, the failure history is cleared and the internal counter is reset.

NOTE: When login attempts are refused from the client IP address, some SSH clients may display the following message: ssh exchange identification: Connection closed by remote host.

See "iDRAC6 Enterprise Property Database Group and Object Definitions" for a complete list of cfgRacTune properties.

"Log In Retry Restriction (IP Blocking) Properties" lists the user-defined parameters.

Table 14-6. Log In Retry Restriction (IP Blocking) Properties 

Enabling IP Blocking

The following example prevents a client IP address from establishing a session for five minutes if that client has failed five login attempts in a one-minute period of time.

racadm config -g cfgRacTuning -o cfgRacTuneIpRangeEnable 1

racadm config -g cfgRacTuning -o cfgRacTuneIpBlkFailCount 5

racadm config -g cfgRacTuning -o cfgRacTuneIpBlkFailWindow 60

racadm config -g cfgRacTuning -o cfgRacTuneIpBlkPenaltyTime 300

The following example prevents more than three failed attempts within one minute, and prevents additional login attempts for an hour.

racadm config -g cfgRacTuning -o cfgRacTuneIpBlkEnable 1

racadm config -g cfgRacTuning -o cfgRacTuneIpBlkFailCount 3

racadm config -g cfgRacTuning -o cfgRacTuneIpBlkFailWindow 60

racadm config -g cfgRacTuning -o cfgRacTuneIpBlkPenaltyTime 3600

Configuring iDRAC6 Telnet and SSH Services Using Local RACADM

The Telnet/SSH console can be configured locally (on the managed server) using RACADM commands.

NOTE: You must have Configure iDRAC6 permission to execute the commands in this section.

NOTE: When you reconfigure Telnet or SSH settings in iDRAC6, any current sessions are terminated without warning.

To enable Telnet and SSH from the local RACADM, log in to the managed server and enter the following commands at a command prompt:

racadm config -g cfgSerial -o cfgSerialTelnetEnable 1

racadm config -g cfgSerial -o cfgSerialSshEnable 1

To disable the Telnet or SSH service, change the value from 1 to 0:

racadm config -g cfgSerial -o cfgSerialTelnetEnable 0

racadm config -g cfgSerial -o cfgSerialSshEnable 0

Enter the following command to change the Telnet port number on iDRAC6:

racadm config -g cfgRacTuning -o cfgRacTuneTelnetPort <new port number>

For example, to change the Telnet port from the default 23 to 8022, enter this command:

racadm config -g cfgRacTuning -o cfgRacTuneTelnetPort 8022

For a complete list of available RACADM CLI commands, see "Using the RACADM Command Line Interface."

Remote and SSH/Telnet RACADM

Remote RACADM is a client side utility, which can be executed from a management station through the out of band network interface. A remote capability option (-r) is provided that allows you to connect to the managed system and execute RACADM subcommands from a remote console or management station. To use the remote capability, you need a valid user name (-u option) and password (-p option), and iDRAC6 IP address. SSH/Telnet RACADM is used to refer to the RACADM command usage from a SSH or Telnet prompt.

The maximum number of simultaneous remote RACADM sessions is four. These sessions are independent and in addition to the Telnet and SSH sessions. iDRAC6 can simultaneously support four SSH sessions and four Telnet sessions, in addition to the four RACADM sessions.

NOTE: Configure the IP address on your iDRAC6 before using the RACADM remote capability.

NOTE: If the system from where you are accessing the remote system does not have an iDRAC6 certificate in its default certificate store, a message is displayed when you type a RACADM command.

Security Alert: Certificate is invalid - Name on Certificate is invalid or does not match site name

Continuing execution. Use -S option for racadm to stop the execution on certificate-related errors.

RACADM continues to execute the command. However, if you use the –S option, RACADM stops executing the command and displays the following message:

Security Alert: Certificate is invalid - Name on Certificate is invalid or does not match site name

Racadm not continuing execution of the command.

ERROR: Unable to connect to iDRAC6 at specified IP address

NOTE: When using the RACADM remote capability, you must have write permissions on the folders where you are using the RACADM subcommands involving file operations, for example:

racadm getconfig -f <file name>

or

racadm sslcertdownload -t <type> [-f <filename>]

Remote RACADM Usage

racadm -r <iDRAC6 IP Address> -u <username> -p <password> <subcommand> <subcommand options>

racadm -i -r <iDRAC6 IP Address> <subcommand> <subcommand options>

For example:

racadm -r 192.168.0.120 -u root -p calvin getsysinfo

racadm -i -r 192.168.0.120 getsysinfo

If the HTTPS port number of iDRAC6 has been changed to a custom port other than the default port (443), the following syntax must be used:

racadm -r <iDRAC6 IP Address>:<port> -u <username> -p <password> <subcommand> <subcommand options>

racadm -i -r <iDRAC6 IP Address>:<port> <subcommand> <subcommand options>

Remote RACADM Options

Table 14-7 lists the options for the remote RACADM command.

Table 14-7. RACADM Command Options 

Using an iDRAC6 Configuration File

An iDRAC6 configuration file is a text file that contains a representation of the values in iDRAC6 database. You can use the RACADM getconfig subcommand to generate a configuration file containing the current values from iDRAC6. You can then edit the file and use the RACADM config -f subcommand to load the file back into iDRAC6, or to copy the configuration to other iDRAC6s.

Creating an iDRAC6 Configuration File

The configuration file is a plain text file. You can use any valid file name; however, the .cfg file extension is the recommended convention.

The configuration file can be:

• Created with a text editor
  
  
• Obtained from iDRAC6 with the RACADM getconfig subcommand
  
  
• Obtained from iDRAC6 with the RACADM getconfig subcommand and then edited
  
  

To obtain a configuration file with the RACADM getconfig command, enter the following command:

racadm -r <remote iDRAC6 IP> -u <user> -p <password> getconfig -f myconfig.cfg

This command creates the file myconfig.cfg in the current directory.

Configuration File Syntax

NOTE: Edit the configuration file with a plain text editor, such as Notepad on Windows or vi on Linux. The racadm utility parses ASCII text only. Any formatting confuses the parser and may corrupt iDRAC6 database.

This section describes the format of the configuration file.

• Lines that start with # are comments.
  
  

A comment must start in the first column of the line. A # character in any other column is treated as a normal # character.

Example:

#

# This is a comment

[cfgUserAdmin]

cfgUserAdminPrivilege=4

• Group entries must be surrounded by [ and ] characters.
  
  

The starting [ character denoting a group name must start in column one. This group name must be specified before any of the objects in that group. Objects that do not include an associated group name generate an error. The configuration data is organized into groups as defined in "iDRAC6 Enterprise Property Database Group and Object Definitions."

The following example displays a group name, object, and the object's property value.

Example:

[cfgLanNetworking] (group name)

cfgNicIpAddress=192.168.1.1 (object name)

• Parameters are specified as object=value pairs with no white space between the object, =, and value.
  
  

White space that is included after the value is ignored. White space inside a value string remains unmodified. Any character to the right of the = is taken as is (for example, a second =, or a #, [, ], and so forth).

• The parser ignores an index object entry.
  
  

You cannot specify which index is used. If the index already exists, it is either used or the new entry is created in the first available index for that group.

The racadm getconfig -f <filename> command places a comment in front of index objects, allowing you to see the included comments.

NOTE: You can create an indexed group manually using the following command: racadm config -g <groupName> -o <anchored-object> -i <index> <unique-anchor-name>.

• The line for an indexed group cannot be deleted from a configuration file.
  
  

You must remove an indexed object manually using the following command:

racadm config -g <groupName> -o <objectName> -i <index> ""

NOTE: A NULL string (identified by two "" characters) directs iDRAC6 to delete the index for the specified group.

To view the contents of an indexed group, use the following command:

racadm getconfig -g <groupName> -i <index>

• For indexed groups the object anchor must be the first object after the [ ] pair. The following are examples of the current indexed groups:
  
  

[cfgUserAdmin]

cfgUserAdminUserName=<username>

• If the parser encounters an indexed group, it is the value of the anchored object that differentiates the various indexes.
  
  

The parser reads in all of the indexes from iDRAC6 for that group. Any objects within that group are simple modifications when iDRAC6 is configured. If a modified object represents a new index, the index is created on iDRAC6 during configuration.

• You cannot specify a desired index in a configuration file.
  
  

Indexes may be created and deleted, so over time the group may become fragmented with used and unused indexes. If an index is present, it is modified. If an index is not present, the first available index is used. This method allows flexibility when adding indexed entries where you do not need to make exact index matches between all the RACs being managed. New users are added to the first available index. A configuration file that parses and runs correctly on one iDRAC6 may not run correctly on another if all indexes are full and you must add a new user.

Modifying iDRAC6 IP Address in a Configuration File

When you modify iDRAC6 IP address in the configuration file, remove all unnecessary <variable>=<value> entries. Only the actual variable group's label with "[" and "]" remains, including the two <variable>=<value> entries pertaining to the IP address change.

For example:

#

# Object Group "cfgLanNetworking"

#

[cfgLanNetworking]

cfgNicIpAddress=10.35.10.110

cfgNicGateway=10.35.10.1

This file will be updated as follows:

#

# Object Group "cfgLanNetworking"

#

[cfgLanNetworking]

cfgNicIpAddress=10.35.9.143

# comment, the rest of this line is ignored

cfgNicGateway=10.35.9.1

Loading the Configuration File Into iDRAC6

The command racadm config -f <filename> parses the configuration file to verify that valid group and object names are present and that syntax rules are followed. If the file is error-free the command then updates iDRAC6 database with the contents of the file.

NOTE: To verify the syntax only and not update iDRAC6 database, add the -c option to the config subcommand.

Errors in the configuration file are flagged with the line number and a message that explains the problem. You must correct all errors before the configuration file can update iDRAC6.

NOTE: Use the racresetcfg subcommand to reset the database and iDRAC6 NIC settings to the original default settings and remove all users and user configurations. While the root user is available, other users' settings are also reset to the default settings.

Before you execute the racadm config -f <filename> command, you can run the racresetcfg subcommand to reset iDRAC6 to its default settings. Ensure that the configuration file you will load includes all desired objects, users, indexes, and other parameters.

To update iDRAC6 with the configuration file, execute the following command:

racadm -r <remote iDRAC6 IP> -u <user> -p <password> config -f myconfig.cfg

After the command has completed, you can execute the RACADM getconfig subcommand to confirm that the update succeeded.

Configuring Multiple iDRAC6s

Using a configuration file, you can configure other iDRAC6s with identical properties. Follow these steps to configure multiple iDRAC6s:

1. Create the configuration file from iDRAC6 settings you want to replicate to the others. Enter the following command:
   
   

racadm -r <remote iDRAC6 IP> -u <user> -p <password> getconfig -f <filename>

where <filename> is the name of a file to save iDRAC6 properties, such a myconfig.cfg.

The below example shows how you can use remote RACADM commands to configure multiple iDRAC6s. Create a batch file on the management station and call remote racadm commands from the batch file.

For example:

racadm -r <Server IP 1> -u <user> -p <password> config -f myconfig.cfg

racadm -r <Server IP 2> -u <user> -p <password> config -f myconfig.cfg

...

See "Creating an iDRAC6 Configuration File" for more information.

NOTE: Some configuration files contain unique iDRAC6 information (such as the static IP address) that must be modified before you export the file to other iDRAC6s.

2. Edit the configuration file you created in the previous step and remove or comment-out any settings you do not want to replicate.
   
   
3. Copy the edited configuration file to a network drive where it is accessible to each managed server whose iDRAC6 you want to configure.
   
   
4. For each iDRAC6 you want to configure:
   
   
   1. Log in to the managed server and start a command prompt.
      
      
   2. If you want to reconfigure iDRAC6 from the default settings, enter the following command:
      
      

racadm racreset

3. Load the configuration file into iDRAC6 with the following command:
   
   

racadm -r <remote iDRAC6 IP> -u <user> -p <password> config -f <filename>

where <filename> is the name of the configuration file you created. Include the full path if the file is not in the working directory.

4. Reset iDRAC6 that was configured by entering the following command:
   
   

racadm reset

Back to Contents Page