-
Notifications
You must be signed in to change notification settings - Fork 7
subcommand overview
This section provides descriptions of the subcommands that are available in the racadm command line interface.
Lists all of the subcommands available to use with racadm and provides a short description for each.
racadm help racadm help
The help subcommand lists all of the subcommands that are available when using the racadm command along with a one-line description. You may also type a subcommand after help to get the syntax for a specific subcommand.
The racadm help command displays a complete list of subcommands.
The racadm help command displays information for the specified subcommand only.
Table A-2 describes the **config and getconfig **subcommands.
Table A-2. config/getconfig
Subcommand
Definition
config
Configures the iDRAC.
getconfig
Gets the iDRAC configuration data.
racadm config [-c|-p] -f
racadm config -g -o [-i ]
The config subcommand allows you to set iDRAC configuration parameters individually or to batch them as part of a configuration file. If the data is different, that iDRAC object is written with the new value.
Table A-3 describes the **config **subcommand options.
Table A-3. config Subcommand Options and Descriptions
Option
Description
-f
The **-f ** option causes config to read the contents of the file specified by and configure the iDRAC. The file must contain data in the format specified in Configuration File Syntax.
-p
The -p, or password, option directs config to delete the password entries contained in the config file **-f ** after the configuration is complete.
-g
The **-g **, or group, option must be used with the -o option. The specifies the group containing the object that is to be set.
-o
The -o ** , or object, option must be used with the -g option. This option specifies the object name that is written with the string **.
**-i **
The -i , or index, option is only valid for indexed groups and can be used to specify a unique group. The index is specified here by the index value, not a "named" value.
**-c **
The -c, or check, option is used with the config subcommand and allows you to parse the .cfg file to find syntax errors. If errors are found, the line number and a short description of what is incorrect are displayed. Writes do not occur to the iDRAC. This option is a check only.
This subcommand generates error output upon encountering either of the following:
- Invalid syntax, group name, object name, index, or other invalid database members
- RACADM CLI failures
This subcommand returns an indication of how many configuration objects that were written out of how many total objects were in the .cfg file.
- racadm config -g cfgLanNetworking -o cfgNicIpAddress 10.35.10.110** **
Sets the cfgNicIpAddress configuration parameter (object) to the value 10.35.10.110. This IP address object is contained in the group cfgLanNetworking.
- racadm config -f myrac.cfg** **
Configures or reconfigures the iDRAC. The myrac.cfg file may be created with the **getconfig **command. The myrac.cfg file may also be edited manually as long as the parsing rules are followed.
The getconfig subcommand allows you to retrieve iDRAC configuration parameters individually, or all the iDRAC configuration groups may be retrieved and saved into a file.
Table A-4 describes the **getconfig **subcommand options.
Table A-4. getconfig Subcommand Options
Option
Description
-f
The** -f** *** ***option directs getconfig to write the entire iDRAC configuration to a configuration file. This file can then be used for batch configuration operations using the config subcommand.
NOTE: The -f option does not create entries for the cfgIpmiPet and cfgIpmiPef groups. You must set at least one trap destination to capture the** cfgIpmiPet** group to the file.
-g
The **-g **, or group, option can be used to display the configuration for a single group. The groupName is the name for the group used in the racadm.cfg files. If the group is an indexed group, use the -i option.
-h
The -h, or help, option displays a list of all available configuration groups that you can use. This option is useful when you do not remember exact group names.
-i
The **-i , or index, **option is valid only for indexed groups and can be used to specify a unique group. If **-i ** is not specified, a value of 1 is assumed for groups, which are tables that have multiple entries. The index is specified by the index value, not a "named" value.
-o
The -o , or object, option specifies the object name that is used in the query. This option can be used with the -g option.
**-u **
The -u , or user name, option can be used to display the configuration for the specified user. The option is the login name for the user.
-v
The -v, or verbose, option displays additional details with the display of the properties and is used with the **-g **option.
This subcommand generates error output upon encountering either of the following:
- Invalid syntax, group name, object name, index, or other invalid database members
- RACADM CLI transport failures
If errors are not encountered, this subcommand displays the contents of the specified configuration.
- racadm getconfig -g cfgLanNetworking** **
Displays all of the configuration properties (objects) that are contained in the group cfgLanNetworking.
- racadm getconfig -f myrac.cfg** **
Saves all group configuration objects from the iDRAC to myrac.cfg.
Displays a list of the available configuration groups on the iDRAC.
Displays the configuration properties for the user named root.
- racadm getconfig -g cfgUserAdmin -i 2 -v
Displays the user group instance at index 2 with extensive information for the property values.
racadm getconfig -f
racadm getconfig -g [-i ]
racadm getconfig -u
racadm getconfig -h
Table A-5 describes the getssninfo subcommand.
Table A-5. getssninfo Subcommand
Subcommand
Definition
getssninfo
Retrieves session information for one or more currently active or pending sessions from the Session Manager's session table.
racadm getssninfo [-A] [-u | *]
The getssninfo command returns a list of users that are connected to the iDRAC. The summary information provides the following information:
- Username
- IP address (if applicable)
- Session type (for example, SSH or telnet)
- Consoles in use (for example, Virtual Media or Virtual KVM)
Table A-6 describes the getssninfo subcommand options.
Table A-6. getssninfo Subcommand Options
Option
Description
-A
The -A option eliminates the printing of data headers.
-u
The -u * user name option limits the printed output to only the detail session records for the given user name. If an asterisk () symbol is given as the user name, all users are listed. Summary information is not printed when this option is specified.
Table A-7 provides an example of output from the **racadm getssninfo **command.
Table A-7. getssninfo Subcommand Output Example
User
IP Address
Type
Consoles
root
192.168.0.10
Telnet
Virtual KVM
"root" 143.166.174.19 "Telnet" "NONE"
- racadm getssninfo -A -u *
"root" "143.166.174.19" "Telnet" "NONE"
- "bob" "143.166.174.19" "GUI" "NONE"
Table A-8 describes the racadm getsysinfo subcommand.
Table A-8. getsysinfo
Command
Definition
getsysinfo
Displays iDRAC information, system information, and watchdog status information.
racadm getsysinfo [-d] [-s] [-w] [-A]
The getsysinfo subcommand displays information related to the iDRAC, managed server, and watchdog configuration.
Table A-9 describes the getsysinfo subcommand options.
Table A-9. getsysinfo Subcommand Options
Option
Description
-d
Displays iDRAC information.
-s
Displays system information
-w
Displays watchdog information
-A
Eliminates the printing of headers/labels.
The getsysinfo subcommand displays information related to the iDRAC, managed server, and watchdog configuration.
RAC Information:
RAC Date/Time = Wed Aug 22 20:01:33 2007
Firmware Version = 0.32
Firmware Build = 13661
Last Firmware Update = Mon Aug 20 08:09:36 2007
Hardware Version = NA
Current IP Address = 192.168.0.120
Current IP Gateway = 192.168.0.1
Current IP Netmask = 255.255.255.0
DHCP Enabled = 1
MAC Address = 00:14:22:18:cd:f9
Current DNS Server 1 = 10.32.60.4
Current DNS Server 2 = 10.32.60.5
DNS Servers from DHCP = 1
Register DNS RAC Name = 1
DNS RAC Name = iDRAC-783932693338
Current DNS Domain = us.dell.com
System Information:
System Model = PowerEdge M600
System BIOS Version = 0.2.1
BMC Firmware Version = 0.32
Service Tag = 48192
Host Name = dell-x92i38xc2n
OS Name =
Power Status = OFF
Watchdog Information:
Recovery Action = None
Present countdown value = 0 seconds
Initial countdown value = 0 seconds
"System Information:" "PowerEdge M600" "0.2.1" "0.32" "48192" "dell-x92i38xc2n" "" "ON"
System Information:
System Model = PowerEdge M600
System BIOS Version = 0.2.1
BMC Firmware Version = 0.32
Service Tag = 48192
Host Name = dell-x92i38xc2n
OS Name =
Power Status = ON
Watchdog Information:
Recovery Action = None
Present countdown value = 0 seconds
Initial countdown value = 0 seconds
The Hostname and OS Name fields in the getsysinfo output display accurate information only if Dell OpenManage is installed on the managed server. If OpenManage is not installed on the managed server, these fields may be blank or inaccurate.
Table A-10 describes the getractime subcommand.
Table A-10. getractime
Subcommand
Definition
getractime
Displays the current time from the remote access controller.
racadm getractime [-d]
With no options, the getractime subcommand displays the time in a common readable format.
With the -d option, **getractime **displays the time in the format, yyyymmddhhmmss.mmmmmms, which is the same format returned by the UNIX date command.
The getractime subcommand displays the output on one line.
racadm getractime
Thu Dec 8 20:15:26 2005
racadm getractime -d
20071208201542.000000
Table A-11 describes the setniccfg subcommand.
Table A-11. setniccfg
Subcommand
Definition
setniccfg
Sets the IP configuration for the controller.
racadm setniccfg -d
racadm setniccfg -s [ ]
racadm setniccfg -o [ ]
The setniccfg subcommand sets the iDRAC IP address.
- The -d option enables DHCP for the NIC (default is DHCP enabled).
- The **-s **option enables static IP settings. The IP address, netmask, and gateway can be specified. Otherwise, the existing static settings are used. , , and must be typed as dot-separated strings.
racadm setniccfg -s 192.168.0.120 255.255.255.0 192.168.0.1
- The -o option disables the NIC completely. , , and must be typed as dot-separated strings.
racadm setniccfg -o 192.168.0.120 255.255.255.0 192.168.0.1
The setniccfg subcommand displays an appropriate error message if the operation is not successful. If successful, a message is displayed.
Table A-12 describes the getniccfg subcommand.
Table A-12. getniccfg
Subcommand
Definition
getniccfg
Displays the current IP configuration for the iDRAC.
racadm getniccfg
The getniccfg subcommand displays the current NIC settings.
The getniccfg subcommand will display an appropriate error message if the operation is not successful. Otherwise, on success, the output is displayed in the following format:
NIC Enabled = 1
DHCP Enabled = 1
IP Address = 192.168.0.1
Subnet Mask = 255.255.255.0
Gateway = 192.168.0.1
Table A-13 describes the getsvctag subcommand.
Table A-13. getsvctag
Subcommand
Definition
getsvctag
Displays a service tag.
racadm getsvctag
The getsvctag subcommand displays the service tag of the host system.
Type getsvctag at the command prompt. The output is displayed as follows:
Y76TP0G
The command returns ** on success and nonzero on errors.
Table A-14 describes the racreset subcommand.
Table A-14. racreset
Subcommand
Definition
racreset
Resets the iDRAC.
racadm racreset
The racreset subcommand issues a reset to the iDRAC. The reset event is written into the iDRAC log.
Start the iDRAC soft reset sequence.
Table A-15 describes the racresetcfg subcommand.
Table A-15. racresetcfg
Subcommand
Definition
racresetcfg
Resets the entire RAC configuration to factory default values.
racadm racresetcfg
The racresetcfg command removes all user-configured database property entries. The database has default properties for all entries that are used to restore the iDRAC back to the default settings.
Table A-16 describes the serveraction subcommand.
Table A-16. serveraction
Subcommand
Definition
serveraction
Executes a managed server reset or power-on/off/cycle.
racadm serveraction
The serveraction subcommand enables users to perform power management operations on the host system. Table A-17 describes the serveraction power control options.
Table A-17. serveraction Subcommand Options
String
Definition
Specifies the action. The string options are:
- powerdown � Powers down the managed server.
- powerup � Powers up the managed server.
- powercycle � Issues a power-cycle operation on the managed server. This action is similar to pressing the power button on the system's front panel to power down and then power up the system.
- powerstatus � Displays the current power status of the server (ON, or OFF).
- hardreset � Performs a reset (reboot) operation on the managed server.
The serveraction subcommand displays an error message if the requested operation could not be performed, or a success message if the operation completed successfully.
Table A-18 describes the racadm getraclog command.
Table A-18. getraclog
Command
Definition
getraclog -i
Displays the number of entries in the iDRAC log.
getraclog
Displays the iDRAC log entries.
racadm getraclog -i
racadm getraclog [-A] [-o] [-c count] [-s start-record] [-m]
The **getraclog -i **command displays the number of entries in the iDRAC log.
The following options allow the getraclog command to read entries:
Table A-19. getraclog Subcommand Options
Option
Description
-A
Displays the output with no headers or labels.
-c
Provides the maximum count of entries to be returned.
-m
Displays one screen of information at a time and prompts the user to continue (similar to the UNIX more command).
-o
Displays the output in a single line.
-s
Specifies the starting record used for the display.
The default output display shows the record number, time stamp, source, and description. The timestamp begins at midnight, January 1 and increases until the managed server boots. After the managed server boots, the managed server's system time is used for the timestamp.
Record: 1
Date/Time: Dec 8 08:10:11
Source: login[433]
Description: root login from 143.166.157.103
racadm clrraclog
The clrraclog subcommand removes all existing records from the iDRAC log. A new single record is created to record the date and time when the log was cleared.
Table A-20 describes the getsel command.
Table A-20. getsel
Command
Definition
getsel -i
Displays the number of entries in the System Event Log.
getsel
Displays SEL entries.
racadm getsel -i
racadm getsel [-E] [-R] [-A] [-o] [-c count] [-s count] [-m]
The **getsel -i **command displays the number of entries in the SEL.
The following getsel options (without the **-i **option) are used to read entries.
Table A-21. getsel Subcommand Options
Option
Description
-A
Specifies output with no display headers or labels.
-c
Provides the maximum count of entries to be returned.
-o
Displays the output in a single line.
-s
Specifies the starting record used for the display.
-E
Places the 16 bytes of raw SEL at the end of each line of output as a sequence of hex values.
-R
Only the raw data is printed.
-m
Displays one screen at a time and prompts the user to continue (similar to the UNIX more command).
The default output display shows the record number, timestamp, severity, and description.
For example:
Record: 1
Date/Time: 11/16/2005 22:40:43
Severity: Ok
Description: System Board SEL: event log sensor for System Board, log cleared was asserted
racadm clrsel
The clrsel command removes all existing records from the System Event Log (SEL).
Table A-22 describes the gettracelog subcommand.
Table A-22. gettracelog
Command
Definition
gettracelog -i
Displays the number of entries in the iDRAC trace log.
gettracelog
Displays the iDRAC trace log.
racadm gettracelog -i
racadm gettracelog [-A] [-o] [-c count] [-s startrecord] [-m]
The gettracelog (without the -i option) command reads entries. The following gettracelog entries are used to read entries:
Table A-23. gettracelog Subcommand options
Option
Description
-i
Displays the number of entries in the iDRAC trace log.
-m
Displays one screen at a time and prompts the user to continue (similar to the UNIX more command).
-o
Displays the output in a single line.
-c
specifies the number of records to display.
-s
specifies the starting record to display.
-A
do not display headers or labels.
The default output display shows the record number, timestamp, source, and description. The timestamp begins at midnight, January 1 and increases until the managed system boots. After the managed system boots, the managed system's system time is used for the timestamp.
For example:
Record: 1
Date/Time: Dec 8 08:21:30
Source: ssnmgrd[175]
Description: root from 143.166.157.103: session timeout sid 0be0aef4
Table A-24 describes the sslcsrgen subcommand.
Table A-24. sslcsrgen
Subcommand
Description
sslcsrgen
Generates and downloads an SSL certificate signing request (CSR) from the RAC.
racadm sslcsrgen [-g] [-f ]
racadm sslcsrgen -s
The sslcsrgen subcommand can be used to generate a CSR and download the file to the client's local file system. The CSR can be used for creating a custom SSL certificate that can be used for SSL transactions on the RAC.
Table A-25 describes the sslcsrgen subcommand options.
Table A-25. sslcsrgen Subcommand Options
Option
Description
-g
Generates a new CSR.
-s
Returns the status of a CSR generation process (generation in progress, active, or none).
-f
Specifies the filename of the location, , where the CSR will be downloaded.
If no options are specified, a CSR is generated and downloaded to the local file system as **sslcsr by default. The -g option **cannot be used with the -s option, and the -f option can only be used with the -g option.
The sslcsrgen -s subcommand returns one of the following status codes:
- CSR was generated successfully.
- CSR does not exist.
- CSR generation in progress.
racadm sslcsrgen -s
or
racadm sslcsrgen -g -f c:csrcsrtest.txt
Table A-26 describes the sslcertupload subcommand.
Table A-26. sslcertupload
Subcommand
Description
sslcertupload
Uploads a custom SSL server or CA certificate from the client to the iDRAC.
racadm sslcertupload -t [-f ]
Table A-27 describes the sslcertupload subcommand options.
Table A-27. sslcertupload Subcommand Options
Option
Description
-t
Specifies the type of certificate to upload, either the CA certificate or server certificate.
1 = server certificate
2 = CA certificate
-f
Specifies the file name of the certificate to be uploaded. If the file is not specified, the sslcert file in the current directory is selected.
The sslcertupload command returns when successful and returns a nonzero number when unsuccessful.
racadm sslcertupload -t 1 -f c:certcert.txt
Table A-28 describes the sslcertdownload subcommand.
Table A-28. sslcertdownload
Subcommand
Description
sslcertdownload
Downloads an SSL certificate from the RAC to the client's file system.
racadm sslcertdownload -t [-f ]
Table A-29 describes the sslcertdownload subcommand options.
Table A-29. sslcertdownload Subcommand Options
Option
Description
-t
Specifies the type of certificate to download, either the Microsoft® Active Directory® certificate or server certificate.
1 = server certificate
2 = Microsoft Active Directory certificate
-f
Specifies the file name of the certificate to be downloaded. If the -f option or the filename is not specified, the sslcert file in the current directory is selected.
The sslcertdownload command returns when successful and returns a nonzero number when unsuccessful.
racadm sslcertdownload -t 1 -f c:certcert.txt
Table A-30 describes the sslcertview subcommand.
Table A-30. sslcertview
Subcommand
Description
sslcertview
Displays the SSL server or CA certificate that exists on the iDRAC.
racadm sslcertview -t [-A]
Table A-31 describes the sslcertview subcommand options.
Table A-31. sslcertview Subcommand Options
Option
Description
-t
Specifies the type of certificate to view, either the Microsoft Active Directory certificate or server certificate.
1 = server certificate
2 = Microsoft Active Directory certificate
-A
Prevents printing headers/labels.
racadm sslcertview -t 1
Serial Number : 00
Subject Information:
Country Code (CC) : US
State (S) : Texas
Locality (L) : Round Rock
Organization (O) : Dell Inc.
Organizational Unit (OU) : Remote Access Group
Common Name (CN) : iDRAC default certificate
Issuer Information:
Country Code (CC) : US
State (S) : Texas
Locality (L) : Round Rock
Organization (O) : Dell Inc.
Organizational Unit (OU) : Remote Access Group
Common Name (CN) : iDRAC default certificate
Valid From : Jul 8 16:21:56 2005 GMT
Valid To : Jul 7 16:21:56 2010 GMT
racadm sslcertview -t 1 -A
00
US
Texas
Round Rock
Dell Inc.
Remote Access Group
iDRAC default certificate
US
Texas
Round Rock
Dell Inc.
Remote Access Group
iDRAC default certificate
Jul 8 16:21:56 2005 GMT
Jul 7 16:21:56 2010 GMT
Table A-32 describes the testemail subcommand.
Table A-32. testemail configuration
Subcommand
Description
testemail
Tests the iDRAC's e-mail alerting feature.
racadm testemail -i
Sends a test e-mail from the iDRAC to a specified destination.
Prior to executing the testemail command, ensure that the specified index in the RACADM cfgEmailAlert group is enabled and configured properly. Table A-33 provides an example of commands for the cfgEmailAlert group.
Table A-33. testemail Configuration
Action
Command
Enable the alert
racadm config -g cfgEmailAlert -o cfgEmailAlertEnable
-i 1 1
Set the destination e-mail address
racadm config -g cfgEmailAlert -o cfgEmailAlertAddress -i 1 [email protected]
Set the custom message that is sent to the destination e-mail address
racadm config -g cfgEmailAlert -o cfgEmailAlertCustomMsg -i 1 "This is a test!"
Ensure the SNMP IP address is configured properly
racadm config -g cfgRemoteHosts -o cfgRhostsSmtpServerIpAddr -i 192.168.0.152
View the current e-mail alert settings
racadm getconfig -g cfgEmailAlert -i **
where ** is a number from 1 to 4
Table A-34 describes the testemail subcommand options.
Table A-34. testemail Subcommand Option
Option
Description
-i
Specifies the index of the e-mail alert to test.
None.
Table A-35 describes the testtrap subcommand.
Table A-35. testtrap
Subcommand
Description
testtrap
Tests the iDRAC's SNMP trap alerting feature.
racadm testtrap -i
The testtrap subcommand tests the iDRAC's SNMP trap alerting feature by sending a test trap from the iDRAC to a specified destination trap listener on the network.
Before you execute the testtrap subcommand, ensure that the specified index in the RACADM cfgIpmiPet group is configured properly.
Table A-36 provides a list and associated commands for the cfgIpmiPet group.
Table A-36. cfg e-mail Alert Commands
Action
Command
Enable the alert
racadm config -g cfgIpmiPet -o cfgIpmiPetAlertEnable -i 1 1
Set the destination e-mail IP address
racadm config -g cfgIpmiPet -o cfgIpmiPetAlertDestIpAddr -i 1 192.168.0.110
View the current test trap settings
racadm getconfig -g cfgIpmiPet -i
where is a number from 1 to 4
Table A-37 describes the testtrap subcommand options.
Table A-37. testtrap Subcommand Options
Option
Description
-i
Specifies the index of the trap configuration to use for the test Valid values are from 1 to 4.