Serial Command Shell CommandsDell™ Embedded Remote Access/MC User's Guide
Using the Remote Racadm Utility and the racadm.cfg File to Configure the Controller
 |
NOTE: The terms ERA/MC controller, controller, and RAC (remote access controller) are used interchangeably throughout this document. |
The serial command shell interface and remote racadm utility interface enable you to setup and configure your controller, the managed system chassis components, and server modules. Serial and remote racadm commands set or retrieve object property values in the controller properties database.
|
NOTE: For specific information about each object property, see "Controller Property Database Group and Object Definitions." |
The serial command shell and remote racadm utility enable you to use racadm subcommands in batch mode. By entering a series of serial or racadm commands, you can perform actions such as upgrading controller firmware, setting a property to a specific value, and viewing the configuration of the controller. You can also use the remote racadm utility to create a configuration file with the racadm cfg subcommand.
|
NOTE: To limit the stress load on the managed system and the controller when using the remote racadm utility, it is important to add one- or two-second "sleep" or "delay" commands between each racadm command. |
Serial commands are entered through Hilgraeve's HyperTerminal software that comes with the Microsoft® Windows® 2000 operating system. The serial interface enables you to use a set of "top-level" serial commands including the racadm command. The racadm command provides several subcommands that perform specific management functions.
The following serial commands can be run from the serial command prompt. To access the serial command prompt, see "Configuring the Management Station."
The following subsections provide information about each of the serial commands.
|
Command |
Definition |
help | Lists commands available from the serial prompt with a one-line description. |
help <command> | Displays the usage statement for the <command>. |
help
help <command>
The help command lists all of the commands that can be run from the serial command prompt. If <command> is included as a target, the help command displays the usage statement for that command.
|
Command |
Definition |
logout | Logs the current user out of the serial command shell, and then displays a new log in prompt. |
logout
exit
|
Command |
Definition |
getsysinfo | Displays general controller information and system information. |
racadm getsysinfo [-r] [-c] [-A] [-f]
The getsysinfo command returns information about the controller, chassis, and system depending on the command options:
The order of data on output is always the same: RAC information, and chassis information. These three major classes of information contain the following elements:
If -d, -r, -f, or -c options are not specified, then the default is all of them.
Without the -A option, the output consists of:
Chassis Information:
System ID = 0X0124
System Model = Dell PowerEdge XXXX
Service Tag = 03F5F8
Asset Tag = EF23VQ-0023
Chassis Name = My System 1
Chassis Location = Loc-11,Bldg-4,Rack-13,Row-2
Server Module Pwr-on mask = 0x0003f
|
NOTE: Chassis Name and Location are strings that the user can configure. |
With the -A option, the chassis information is output as follows:
"Chassis Info:" "0X0124" "Dell PowerEdge XXXX" "03F5F8" \
"EF23VQ-0023" "My System" "Loc-11,Bldg-4,Rack-13,Row-2" \"0x0003f"
-d or -r – Displays controller information.
-c – Displays chassis information.
-A – Eliminates the printing of headers/labels.
-f – Displays firmware status flags.
If -d, -c, or -f options are not specified then the RAC information and chassis information are displayed.
Every data element is output as a string.
racadm getsysinfo -c
Chassis Information:
System ID = 0X0124
System Model = Dell PowerEdge XXXX
Service Tag = 03F5F8
Asset Tag = EF23VQ-0023
Chassis Name = My System 1
Chassis Location = Loc-11,Bldg-4,Rack-13,Row-2
racadm getsysinfo -c -A
"Chassis Info:" "0X0124" "Dell PowerEdge XXXX" "03F5F8" \
"EF23VQ-0023" "My System 1" "Loc-11,Bldg-4,Rack-13,Row-2"
|
Command |
Definition |
getmodinfo | Displays module configuration and status information. See Table A-6. |
getmodinfo [-m <module>] [-A] [-G <generation>]
The getmodinfo command displays the following information about the major modules in a chassis:
<module> has the following values:
The default is to display information about all of the major modules in the chassis. The -A option suppresses the header and outputs <presence>, <pwrState>, and <health> as a numeric character.
The -G <generation> option returns 1 if <generation> matches the current generation of the module resource table (indicating any changes since the last call). If the generation is new and the -G option was used, the following line is printed before the rest of the module information:
"Generation: <n> " where <n> is the generation number.
A <generation> value of 0 always causes a mismatch and thus new output.
Table A-6. getmodinfo Output Example
Generation: 34323 | |||||
|---|---|---|---|---|---|
#<group> | <presence> | #<module> | <pwrState> | <health> | <svcTag> |
1 | Chassis | Present | ON | Warning | 4TY9W29 |
Fan-1 | Present | ON | Failed | 4TY9W29 | |
Smcard | Present | ON | OK | 4TY9W29 | |
2 | Server-1 | Present | OFF | na | 88P9A46 |
The getmodinfo command returns without output if successful, and prints a line of output for each module specified.
|
Command |
Definition |
getsensorinfo | Displays sensor information. |
getsensorinfo [-s <sensorNum>] [-G <generation>]
The getsensorinfo command dumps the current sensor reading and enables status for the specified sensors.
The list of sensors that is displayed is platform dependent and corresponds to the sensor readings generated by the getsensorinfo command. By default, information for all sensors in the standard sensor list for the system is displayed.
-s – Allows a specific sensor to be specified by the IPMI sensor number.
-G – The -G <generation> option returns 1 if <generation> matches the current generation of the sensor status table (indicating any changes since the last call). If the generation is new and the -G option was used, the following line is printed before the rest of the modinfo:
"Generation: <n>" where <n> is the generation number.
A <generation> value of 0 always causes a mismatch and thus new output.
Output values correspond with IPMI definitions. One line of output is generated for each sensor. The output line for threshold sensors contains the information in Table A-8:
Table A-8. getsensorinfo Output Example
Generation: 3233 | |||||||||
|---|---|---|---|---|---|---|---|---|---|
#senType> | <Num> | <module> | <status> | <reading> | <units> | <lc> | <lnc> | <unc> | <uc> |
FanSpeed | 1 | fan-1 | warning | 1900 | rpm | 1000 | 1300 | 1800 | 2000 |
Temp | 20 | ps-1 | normal | 25 | celcius | 20 | 25 | 45 | 50 |
#senType> | <Num> | <module> | <status> | <failStatus> | <AC-OK status> | ||||
PwrSupply | 30 | ps-1 | ON | OK | present |
|
Command |
Definition |
getraclog -i | Displays the number of entries in the RAC log. |
getraclog | Displays the RAC log entries. |
getraclog -i
getraclog [-A] [-c count] [-d delay-seconds ]\[-s start-record] [-v] [-V] [-m]
|
NOTE: The command name and the racadm subcommand names may be different. This is normal. |
The getraclog -i command displays the number of entries in the RAC log.
The clrraclog command completely clears the RAC log. A single entry is made to indicate the user and time that the log was cleared.
The following are options for the getraclog command to read entries:
One line of output is displayed for each RAC log entry.
The output buffer size is too big for execution across IPMI transport.
|
Command |
Definition |
getsel -i | Displays number of entries in the System Event Log. |
getsel | Displays SEL entries. |
getsel -i
getsel [-E] [-R] [-A] [-c count] [-d delay-seconds]\[-s count] [-v] [-V] [-m]
The getsel -i command displays the number of entries in the SEL.
The clrsel command completely clears the SEL.
The following getsel options (without the -i option) are used to read entries.
-A – Provides API-formatted output (no header).
-c – Provides the maximum count of entries to be returned.
<blank> – Default is to display the entire log) racadm and serial only.
-d – Provides the number of seconds to delay the recording of any new log entries.
-s – Provides the number of records to skip before returning entries (default=0).
-v – Provides "verbose" output.
-V – Provides "Very verbose" output.
-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 24 rows at a time, and queries for more (such as the UNIX more command).
One line of output is displayed for each SEL entry.
|
Command |
Definition |
serveraction | Executes a server module reset or power-on/off/cycle. |
serveraction [-s <sysNum>] [-d <delay>][-w <cycleWait>] <action>
The serveraction command provides an interface to control system reset and power control.
The <action> string specifies the action.
The <sysNum> string specifies the system number. 0 is the default. The system number corresponds to the server module number as in the following example:
Server-1 => System-1
sysNum = ALL causes the action to be applied to all systems.
The following are options for the <action> string:
The <delay> option specifies the time in seconds after the command is received before the action is executed. The default is 1 second.
The serveraction command returns with no output if successful.
|
Command |
Definition |
setled | Set the state of the LEDs on a server module. |
getled | Displays the LED settings on a server module. |
setled -m <module> [-l <ledState>] <VALUE>
getled -m <module> [-l <ledState>]
The setled command sets the state of the specified LED on a server module.
The input parameters may be the following values:
<module> – server-<n> (n=1 to 6). For example:
server-1 or
chassis
<ledState>
<VALUE> — ON, OFF
setled -m server-1 ON (This turns on locate LED on server module 1.)
The getled command outputs the current state of the specified LED on a module.
<module> and <ledState> have the same meaning as the setled command.
getled -m server-1
ON
The setled command returns without output if successful. The getled command prints the LED state for the specified module and LED.
The only valid value for the <ledState> option is 1.
|
Command |
Definition |
connect | Connects to a server module or switch serial port. |
connect [-b] [-u] <module>
The connect command causes the management serial port to connect to the serial port associated with the module specified by <module>.
This command is used to connect the system management serial port to a server module serial port, or a switch serial port.
The <module> parameter has the following values for the connect command:
The following options are available for the connect command:
-b – Connects in binary mode (normally used for downloading or uploading binary files).
-u – Connects in unsecure mode. Use unsecure mode if you need to disconnect your serial cable from the management serial port without causing the controller to log you off of the session.
If options are not specified, the default connection is in text and secure mode.
|
NOTE: Because binary and unsecure mode is not supported, the -b and -u options cannot be used together. |
The connect command output prints the following single output line and then connects to the port:
Connected to <module> ..."
When the connection is terminated (with the "<CR>~." sequence in text mode), the following output is printed:
Connection to <module> terminated."
<CMD_PROMPT>
and a command prompt is printed.
|
Command |
Definition |
gettracelog -i | Displays the number of entries in the RAC trace log. |
gettracelog | Displays the RAC trace log. |
gettracelog -i
gettracelog [-m]
The gettracelog -i command displays the number of entries in the RAC trace log. The gettracelog (without -i option) command is used to read entries.
The -m option displays 24 rows at a time, and queries for more (such as the UNIX more command).
One line of output is displayed for each trace log entry.
The racadm command can be entered at the serial command shell. The racadm command provides a number of subcommands that can be used to configure the controller. This section includes information about the racadm command and the racadm command subcommands.
|
Command |
Definition |
racadm | Executes a racadm subcommand. |
racadm <subcommand>
Without options, the racadm command executes the help command, which displays a list of available tests and a one-line description of each. The racadm help <subcommand> displays any syntax and command-line options for the subcommand.
The following subsections provide descriptions of subcommands that you can run under the racadm command-line utility. The primary reason that a command is limited as a racadm subcommand is to enforce the only "root" an "racadmuser" users can execute these commands. Table A-16 briefly describes each racadm subcommands.
Table A-16. Racadm Subcommand Man Pages
|
Command |
Description |
|---|---|
Lists controller subcommands. | |
help <subcommand> | Lists usage statement for the specified subcommand. |
Configures and displays Ethernet management port settings. | |
Configures and displays the controller configuration. | |
Sets and displays general controller and system information. | |
Displays information about active sessions. | |
Sets and displays the asset tag for a module or all modules with unique service tags. | |
Displays the service tag for a module or all modules with unique service tags. | |
Updates the firmware on the controller. | |
Resets the controller. | |
Resets the controller to the default configuration. | |
Displays and clears the RAC log. | |
Displays the last controller coredump. | |
Deletes the core dump stored in the controller. | |
Sets and displays the manufacturing configuration mode. | |
Sets and displays the time on the controller. | |
Displays status information about the chassis modules. | |
Displays the selected primary sensors in the chassis. | |
Displays the chassis system event log. | |
Allows the user to power-on, power-off, or restart individual or all server modules. | |
Displays the current server module status and sets the indicator to blink blue so it can be identified. |
|
Command |
Definition |
help | Lists all of the subcommands that are available on racadm and a short description. |
help <subcommand> | Displays usage information for a specific subcommand. |
racadm help
racadm help <subcommand>
The help subcommand lists all of the subcommands that are available under racadm, along with a short one line description. You may also enter 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 <subcommand> displays usage information for the specified subcommand only.
|
Command |
Definition |
clrraclog | Clears the RAC log. |
racadm clrraclog
The clrraclog command completely clears the RAC log. A single entry is made to indicate the user and time that the log was cleared.
|
Command |
Definition |
clrsel | Clears the SEL. |
racadm clrsel
The clrsel command completely clears the SEL.
Table A-20. setmnfgcfg/getmnfgcfg
|
Command |
Definition |
setmnfgcfg | Set manufacturing configuration mode. |
getmnfgcfg | Display manufacturing configuration mode. |
racadm setmnfgcfg [<n>]
racadm getmnfgcfg
The setmnfgcfg command sets the manufacturing mode to integer <n>. n=0 for normal user operation. The default is 0 if <n> is not specified.
The setmnfgcfg command performs the following operations:
The setmnfgcfg command returns with no output if successful.
The getmnfgcfg command prints the manufacturing mode in decimal.
Table A-21. setractime/getractime
|
Command |
Definition |
setractime | Sets the time on the controller. |
getractime | Displays the time from the controller. |
 |
NOTICE: You must reconfigure the controller time whenever you perform a firmware update or a RAC reset, or whenever you lose AC power to the chassis. |
racadm setractime -s
racadm setractime -u <utctime> [-o <offset>]
racadm setractime -d yyyymmddhhmmss.mmmmmms<offset>
racadm getractime [-u] [-d]
The setractime subcommand sets the time on the controller. The time can be specified in three different ways and the default is -s.
-s – Available only if executed from the remote racadm utility (not serial). The time is taken from the system time that racadm is executing.
The racadm setractime subcommand calls the librac function "drsGetOsTime(UINT32 *utcTime, UINT32 *utcOffset) to get the time and offset from the operating system and then executes the command:
setgmt -u <utctime> -o <offset>
-u – The time is specified by the user in UTC-seconds since 1/1/1970.
-o – The offset used with -u is the seconds offset from GMT (a signed value)
-d – The local time is specified as a string: yyyymmddhhmmss.mmmmmms<offset>, where yyyy is a 4-digit year.
For example, Monday, May 25, 2003, at 1:30:15 PM EST would be represented as: 20030525133015.0000000-300.
The getractime subcommand displays the time in one of the two formats:
The setractime subcommand returns without output if successful and the getractime subcommand displays the output on one line.
The -s option for setractime is only available as a racadm subcommand.
Table A-22. setniccfg/getniccfg
|
Command |
Definition |
setniccfg | Sets the IP configuration for the controller. |
getniccfg | Displays the current IP configuration for the controller. |
|
NOTE: The terms NIC and Ethernet management port may be used interchangeably. |
racadm setniccfg -d
racadm setniccfg -s [<ipAddress> <netmask> <gateway>]
racadm setniccfg -o
racadm getniccfg
The setniccfg subcommand sets the controller IP address.
<ipAddress>, <netmask>, and <gateway> are entered as dot-separated strings.
The getniccfg subcommand displays the current Ethernet management port settings
The setniccfg subcommand returns without output if successful. The getniccfg subcommand output displays the following information:
NIC = Enabled/Disabled
DHCP = Enabled/Disabled
Static IP Settings: <ipAddress> <netmask> <gateway>
Current IP Settings: <ipAddress> <netmask> <gateway>
|
Command |
Definition |
getsvctag | Displays a service tag. |
racadm getsvctag [-m <module>]
The getsvctag subcommand is used to display the service tag for a module or all modules with unique service tags. The default is all service tag modules.
Type getsvctag at the command prompt. The output is displayed as follows:
chassis Y76TP0G
server-1 Y76TP0H
server-n TR3H33P
Both commands return 0 on success and nonzero on errors.
Table A-24. setassettag/getassettag
|
Command |
Definition |
setassettag | Sets the specified asset tag. |
getassettag | Displays asset tags. |
racadm setassettag -m <module> <assetTag>
racadm getassettag [-m <module>]
The setassettag subcommand is used to set the asset tag for the specified module. Only the chassis asset tag can be set or displayed.
<module> has the following legal value: chassis.
<assetTag> is the N-byte ASCII asset tag where N must be less or equal to 10 bytes.
The getassettag subcommand is used to display the asset tag for a module or all modules with unique asset tags. The default is all modules (that have asset tags).
Type getassettag at the command prompt. The output is displayed as follows:
chassis 7837339-33.
Both subcommands return 0 on success and nonzero on errors.
|
Command |
Definition |
coredump | Displays the last controller core dump. |
racadm coredump [-m] [<recNum>]
The coredump command displays detailed information, including register values, stack values, recorded when the most recent bus error occurred, or the message No CORE dump available (if a previous bus error has not occurred or if the data has been cleared).
This bus error information is persistent across power cycles of the controller adapter. The data remains in the flash memory of the adapter until either it is cleared by the coredumpdelete command, or another bus error occurs, thus replacing the previous information with the more recent bus error information.
If <recNum> is not specified, all coredump output is displayed; otherwise, only the coredump record specified by <recNum> is displayed.
|
NOTE: See "coredumpdelete" for information about deleting the coredump data. |
The option -m may display a set amount of information at a time, and query for more (such as the UNIX more command).
FW d_cmdCoreDump:
Last CORE dump at DSU+00:03:59
Reserved Exception Running: 'PPPD' -#00590000
--------------------------------------------------------------
CPSR = 60000093 (nZCv If SVC32) SP =01735DEC LR =0102CE68
R0 =01392F60 R1 =00000000 R2 =00790000 R3 =01392540 R4 =01392F60
R5 =FFFFFFFE R6 =01309602 R7 =00000000 R8 =00000000 R9 =0138ADD8
R10=60000093 R11=60000093 R12=01392FE8 USP=DEADBEEF ULR=00000000
SSP=01735DEC SLR=0102CE68 SPSR_svc=60000093
PC =FFFFFFFC-FFFFFFFC:
Image ID: John Tue Apr 23 16:24:50 CDT 2002 //1SR3Q01/c/esm4/fw/rmc
Sysuptime: 91
NEXTRECORD=0x00000001
FIQ stack
01215878: 00000000 00000000 00000000...
NEXTRECORD=0x00000002
FW d_cmdCoreDump: No CORE dump available.
|
Command |
Definition |
coredumpdelete | Deletes the coredump stored in the controller. |
racadm coredumpdelete
The coredumpdelete command clears the area reserved for persistent storage of bus error information. This operation is performed regardless of whether any bus error information currently exists stored in the area reserved for this information.
|
NOTE: See "coredump" for information about displaying the bus error information. |
|
NOTE: You may also use the racreset command to clear coredump information. |
|
Command |
Definition |
racreset | Resets the controller ESM. |
racadm racreset <hard | graceful | soft> [<delay>]
The racreset subcommand issues a reset to the ESM. The user is allowed to select how many seconds of delay occur before the reset sequence is started. The reset event is written into the dra3log.
To start the controller soft reset sequence in 20 seconds, type the following at the command prompt:
racadcm racreset soft 20
|
Command |
Definition |
racresetcfg | Reset all configuration parameters to default values. |
|
NOTICE: You must reconfigure the controller time after each RAC reset. |
racadm racresetcfg
|
NOTICE: Before using this subcommand, be absolutely sure that you want all of your database properties to return to the default settings. |
The racresetcfg command removes all database property entries that have been configured by the user. The database has default properties for all entries. If an entry is modified, it is copied to the config directory and modified. This function removes the /config entries which restores the card back to preinstalled default settings. After resetting the database properties, the controller automatically resets.
|
Command |
Definition |
fwupdate | Updates the firmware on the controller. |
racadm fwupdate -u [-w] [-D]
racadm fwupdate -s
racadm fwupdate -g [-u] [-w] [-D] [-a <IP ADDRESS>] -f path/file
racadm fwupdate -g [-u] [-w] [-D] [-a <IP ADDRESS>] -d path
The fwupdate subcommand allows the user to update the firmware on the controller. The user may:
A general message is displayed to indicate what operation is being performed. To perform the following examples, enter each subcommand at the command prompt.
racadm fwupdate -g -a 143.166.154.143 -d RAC\1.1.0\
In this example, the -g option tells the firmware to get the firmware update file from the location specified by the -d option from the TFTP server, at the IP address specified by the -a option. The firmware is then loaded into the RAM disk. Because the -u option is not present, an update does not occur.
fwupdate Example 2
racadm fwupdate -s
The -s option reads the current status of the firmware update.
fwupdate Example 3
racadm fwupdate -u
The -u option begins the update process. It assumes that a valid firmware update file has been previously loaded by means of the -g option. The update file checksum is verified for correctness before the update process begins.
fwupdate Example 4
racadm fwupdate -g -u -a 143.166.154.143 -d Dell\RAC\1.1.0\
In this example, the -g option tells the firmware to get the firmware update file from the location specified by the -d option from the TFTP server, at the IP address specified by the -a option. The -u option tells the controller to proceed with the update after the load.
|
Command |
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 <user name>]
The getssninfo command returns a list of currently active or pending users, and optionally includes summary session table information. The summary information provides the total number of sessions in each of the following defined Session Manager states.
-A –The -A option eliminates the printing of data headers.
-u –The "-u <username>" option limits the printed output to only the detail session records for the given username. If an "*" is given as the username, all users are listed. Summary information is not printed when this option is specified.
Session table status:
4 FREE
0 PRELIMINARY
0 UNVALIDATED
1 VALID
0 INVALID
SessionID | User | Status | IP Address | LoginDate/Time | Con
---------------------------------------------------------------------------------------------------------------------
0x10419A09 ADMIN VALID 143.166.154.86 Thu, 01 Jan 1970 00:00:37 GMT N
4 0 0 1 0
0x10419A09 ADMIN VALID 143.166.154.86 "Thu, 01 Jan 1970 00:00:37 GMT" N
0x10419A09 ADMIN VALID 143.166.154.86 "Thu, 01 Jan 1970 00:00:37 GMT" N
|
Command |
Definition |
config | Configures the controller. |
getconfig | Displays the controller configuration data. |
racadm config -g <groupName> -o <objectName> [-i <index>] <Value>
racadm getconfig -g <groupName> [-i <index>]
racadm getconfig -u <username>
The configuration subcommand allows the user to set controller configuration parameters individually, or batch them as part of a configuration file.
|
NOTE: For more information about group and object names, see "Controller Property Database Group and Object Definitions." |
-g – The "-g <groupName>" or group option must be used with the -o option. The groupName option specifies the group containing the object that is to be set.
-o – The "-o <objectName> <Value>" or object option must be used with the -g option. This specifies the object name that is written with the string <Value>.
-i – The "-i <index>" or index option is only valid for indexed groups, and can be used to specify a unique group. The <index> is a decimal integer from 1-16. If the -i <index> option is not specified, a value of 1 is assumed for groups, which are tables and have multiple entries. Note that the index is specified here by the index value—not a "named" value.
Error output is generated from invalid syntax (including group name, object name, index, and so on) and transport failures. No output generated for correct operation.
The getconfig subcommand allows the user to retrieve controller configuration parameters either on an individual basis, or in configuration groups. Configuration groups may be retrieved and saved into a file.
The -g option allows the user to enter the group name "help." This displays a list of all the available configuration groups so the user may then enter the desired group. This is a convenient way of looking up the exact group names when you are without this documentation. For example, enter racadm getconfig -g help.
Error output is generated from invalid syntax (including group name, object name, index, and so on) and racadm transport failures. Otherwise, the output displays the contents of the specified configuration.
To perform the following examples, enter each subcommand at the command prompt.
racadm getconfig -g cfgLanNetworking
This command will display all of the configurations parameters (objects) that are contained in the group "cfgLanNetworking".
racadm getconfig -g cfgLanNetworking -o Example
racadm config -g cfgLanNetworking -o cfgNicIpAddress 10.35.10.100
This command will set the cfgNicIpAddress configuration parameter (object) to the value 10.35.10.110. This IP address object is contained in the group cfgLanNetworking.
racadm getconfig -g help Example
racadm getconfig -g help
Displays a list of the available configuration groups on the controller.
racadm getconfig -u Example
racadm getconfig -u ADMIN
Displays the configuration parameters for the user named "ADMIN."
racadm getconfig -g cfgUserAdmin
racadm config -g cfgUserAdmin -o cfgUserAdminUserName -i 2 john_doe
This command creates a new user named "john_doe." The cfgUserAdmin group is an indexed group so the -i option is used to specify an index from 1–16.
|
Command |
Definition |
setsysinfo | Sets the chassis name and location. |
racadm setsysinfo chassis_name=<value>
racadm setsysinfo chassis_location=<value>
The setsysinfo subcommand is used to set the chassis name and chassis location properties. <value> is the N-byte ASCII chassis name or location. The chassis name and location can be viewed in the getsysinfo command chassis status field.
|
Command |
Definition |
settracelog | Sets the tracelog flag. |
settracelog -s | Displays the current trace log flag setting. |
racadm settracelog -s
racadm settracelog [-c] [-d] [-i] [-p] [-t]
With no arguments, the settracelog subcommand clears all flags.
The remote racadm utility is available on the Systems Management CD (32-bit systems) and is installed automatically when perform a quick installation using the Systems Management CD.
|
NOTE: For information about installing the Systems Management CD software, see your Dell OpenManage Software Quick Installation Guide. |
The remote racadm utility runs on either the Windows 2000 or Windows NT® system and can send racadm subcommands to your system across a network. The user must specify the IP address of the system ERA/MC controller, as well as the user name and password. The password is encrypted by means of a challenge-response protocol. In addition, commands are nonreplayable if observed on the network from a previous execution.
racadm <dbgOpts> [-u <user name>] -p <password> -r <racIpAddr> <subcommand>
racadm <dbgOpts> -i -r <racIpAddr> <subcommand>
racadm <dbgOpts> -r <racIpAddr> <subcommand>
The remote racadm is a command-line utility that can execute a large set of "subcommands" described below. Each subcommand has its own options and arguments. The remote racadm utility may only be run if the user is logged in as "root" or "racadmuser."
The base racadm command has the following options:
If neither the -p or -i options are specified, the racadm command attempts to communicate with the controller with "AUTH_NONE" security. If the controller has remote security enabled, the command fails.
The remote racadm main command has the debug options shown in Table A-34.
Table A-34. Remote Racadm Debug Options
Table A-35. Log/Verbose Level Options
|
Option |
Description |
0x1 | Standard out messages |
0x2 | Standard error messages |
0x4 | Debug messages |
Example:
racadm -l 0x3 -L log <subcommand [subcommand_options]>
The argument 0x3 for the log level is the OR of STDOUT and STDERR messages. Both of these message types are written to the file name log. The verbose, or -v, option defaults to 0x3, or STDOUT, STDERR.
When using racadm commands and subcommands, you may encounter one or more of the following errors:
Example:
racadm <subcmd>: ERROR:<message>
Example:
racadm <subcmd> : Transport : ERROR : <message>
Example:
racadm <subcmd> : Firmware : ERROR : <message>
The following racadm subcommands are supported by the remote racadm utility:
Each subcommand outputs as described in the man page for that subcommand. If the user is not "root" or "racadmuser" the following error message is displayed:
Permission Denied
The user must be "root" or "racadmuser" to execute a racadm command or subcommand.
The subcommands in this subsection are for the remote racadm utility only and are not supported in the serial command interface. They can be used to test the alert functions of the controller.
|
Command |
Description |
testemail | Test an e-mail alert |
racadm testemail <-i <index> | -u <username>>
The testemail subcommand forces the controller to send an e-mail over the Ethernet management port.
|
Option |
Description |
-u | The user option specifies the user to send the |
-i | Used to specify the index of the user. |
None
|
Command |
Description |
testtrap | Test an SNMP trap |
racadm testtrap [-i <index>]
The testtrap subcommand forces the controller to send an SNMP trap over the Ethernet management port.
|
Option |
Description |
-u | The user option specifies the user that is sending the trap. The necessary properties must be setup to correctly send the trap. |
-i | Used to specify the index of the user. |
None
One of the major features of the racadm utility is the ability to configure the controller using a configuration file. The racadm utility parses the controller configuration file, called racadm.cfg (see "Controller Configuration File") and then sends individual configuration requests to one or more controllers.
This method may be used to configure multiple controller database properties. You must first run the racadm utility to query a configured controller for its database properties, which are accessed using their object group IDs and object IDs. The racadm utility creates the racadm.cfg file from the retrieved information. You can then easily configure other cards with the same database information by pushing this file out to the other controllers.
|
NOTE: Some configuration files contain unique controller information (such as static IP address) that must be modified before configuring other cards. |
The following are the general steps for this procedure:
The getconfig –f racadm.cfg subcommand requests the configuration of the controller and generates a racadm.cfg file (you can choose any name for this file).
Other options for getconfig enable you to perform such actions as:
The config subcommand loads the information into other controllers. Other options for config enable you to perform such actions as:
The initial configuration file, racadm.cfg, is named by the user. In the following example, the configuration file is named myfile.cfg. To obtain this file, type the following command at the command prompt:
racadm getconfig –f myfile.cfg
|
NOTICE: Dell recommends that you edit this file with a simple text editor; the racadm utility uses an ASCII text parser, and any formatting confuses the parser and might corrupt the racadm database. |
The following example describes the IP address of the controller. Remove all unnecessary <variable>=value entries. In this case, only the actual variable group's label with "[" and "]" will remain along with the two <variable>=value entries pertaining to the IP address change.
The file contents are as follows:
#
# 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
The command racadm config –f myfile.cfg parses this file and identifies any errors by line number. A correct file will update the proper entries. You may use the same getconfig command used in the previous example to confirm the update.
This file can be used to download company-wide changes or to configure new systems over the network.
The controller configuration file <filename>.cfg is used with the remote racadm config -f <filename>.cfg command. The configuration file is a simple text file that allows the user to build a configuration file (similar to a .ini file) and configure the controller from this file. You may use any file name, and the file does not require a .cfg ending (although it is referred to by that designation in this subsection). The .cfg file can be:
|
NOTE: See "Configure/Get Configuration" for information about the getconfig command. |
The .cfg file is first parsed to verify that valid group and object names are present and that some simple syntax rules are being followed. Errors are flagged with the line number in which the error was detected, and a simple message displays explaining the problem. The entire file is parsed for correctness, and all errors are displayed. No write operations are performed to the controller if an error is found in the .cfg file. The user must correct all errors before any configuration can take place. The -c option may be used in the config subcommand, which verifies syntax only and does not perform write operations to the controller.
Be aware of the following important points:
|
NOTICE: Using the racresetcfg subcommand resets the database to the original default settings and removes all users and user configurations. While the root user is available, these settings are also reset to the default. |
Use the following parsing rules when you create a controller configuration file.
Example:
#
# This would be a comment
[cfgUserAdmin]
cfgUserAdminPageModemInitString=<Modem init # not a comment>
[cfgLanNetworking]
cfgNicIpAddress=143.154.133.121
See the example in the previous bullet.
|
NOTE: The user may create an indexed group manually using the following command: |
racadm config -g <groupName> -o <anchored object> -i <index 1-16> <unique anchor name>
racadm config -g <groupName> -o <objectName> -i <index 1—16> ""
|
NOTE: A NULL string (two " characters [""]) directs the controller 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 1-16>
[cfgUserAdmin]
cfgUserAdminUserName=<username>
"
[cfgTraps]
cfgTrapsDestIpAddr=<IP_ADDRESS>
"
"
[cfgDemandDial]
cfgDemandDialIpAddr=<IP_ADDRESS>
"
[cfgDialinUsers]
cfgDialinUsrPppUserName=<USER_NAME>
'
'
|
NOTE: Enter the racadm getconfig -f <myexample>.cfg command. This command builds a .cfg file of the current controller configuration. This file can be used as an example and as a starting point for your unique .cfg file. |
The controller property database is a persistent repository of configuration information that you can modify to achieve specific behavior by the controller firmware. When you use the racadm utility to configure the controller, you are making changes in the property database.
The controller property database is structured as object groups and objects. Objects represent data types called properties (such as integer properties or boolean properties) that have property values. See the "Controller Property Database Group and Object Definitions" for more information on the property database.
The following sections define the user database property members and their default values.
The controller alert filter scans the alert enable database properties before it scans the event masks. (An event mask is a bit sequence that specifies information about the controller- or managed-system-generated event, such as the event's origin, type, and severity).
|
NOTE: Throughout this document, objects are always referred to by group name and object name, separated by a space. |
The controller alert filter operates according to the following general steps:
The alert enable property group ID is cfgUserAdmin. The object ID is:
If this object's property values is TRUE, it scans the event masks in the User table.
The following subsections describe the event masks for controller-generated events and managed-system generated events defined in the User table and the Trap table.
The following properties are unsigned 32-bit integer properties that hold filter information for managed-system generated events:
Table A-39. System-Generated Alert Mask Groups and Objects
|
Group |
Object/Property |
|---|---|
cfgUserAdmin | cfgUserAdminAlertFilterSysEventMask |
cfgTraps | cfgTrapsFilterSysEventMask |
The bit definitions in Table A-41 apply:
Table A-40. Alert Mask Bit Definitions
where <senMask> has the following bit definitions:
where <statMask> has the following bit definitions:
The alert-related property group ID is cfgUserAdmin. Table A-41 lists the object groups and object IDs.
Table A-41. Alert-Related Groups and Object IDs
You can test alerts using two test commands. The racadm command has two subcommands that test the different types of alert interfaces. These object ID sets cause the firmware to execute the subcommand with the option that indicates the test alert type to test. The test message is preset in properties for each test alert type. The two types of alerts are e-mail, and trap.
The following subsection describes the command interfaces and the operation of the subcommand for each option.
Synopsis
racadm testemail –i <index>
racadm testemail –u <username>
Alert Data Definitions
The e-mail alert contains the following information: message (including test message, if a paging test), event description, date, time, severity, system ID, model, BIOS version, asset tag, service tag, managed system name, operating system type, and operating system name, and ESM version. The following is an example test e-mail (fields shown are examples only and may not reflect actual observed output for your environment):
Subject: Alert from Dell Remote Access Card: 10.35.10.108
Message: TEST PAGE
Event: Email paging test to user 1
Date: 06-jun-2001
Time: 00:01:37
Severity: Info/Normal
System ID: Bbn
Model: Dell PowerEdge 1655MC
Asset tag: 181676
Service tag: 6X713
Hostname: P2-750-08
ESM Version: 1.3 Dell Computer Corporation
Synopsis
racadm testtrap –i <trap index>
Alert Data Definitions
The "alertMessage" string (up to 1 KB) provides the specific information describing the cause and specific source of the event, which includes:
For more information, see the Server Administrator SNMP Reference Guide.