Conventions for Parameter TablesDell OpenManage™ Server Administrator Version 1.4 Command Line Interface User's Guide
Conventions for Parameter Tables
Help With the omconfig Command
The omconfig command allows you to provide values that define warning events, configure alert actions, clear logs, and configure system shutdown, as well as allowing you to perform other systems management tasks.
Examples of omconfig capabilities include the administrator's privilege to clear command, alert, and hardware logs; the administrator's privilege to configure and execute system shutdown; power user and administrator's privilege to default or specify values for warning events on current probes, fans, voltage probes, and temperature probes; power user and administrator's privilege to set alert actions in the event of a warning or failure event from intrusion, current probes, fans, voltage probes, and temperature probes.
For information on how to use the omconfig system command to view and to manage cost of ownership information (assetinfo), see "omconfig system assetinfo: Editing Cost of Ownership Values."
Often you must use the omreport commands to get the information you need to execute an omconfig command. For example, if you want to edit the minimum temperature for a warning event on a temperature probe, you need to know the index of the probe you want to configure. You can use the omreport chassis temps command to display a list of probes and their indexes. For more information on using the omreport command, see "omreport: Viewing System Status Using the Instrumentation Service."
When listing the parameters that a command can take, the parameters are listed in alphabetical order instead of the order in which they appear in the command line interface.
The symbol |, often called pipe, is the logical exclusive or operator. For example, enable | disable means that you can enable or disable the component or feature, but you cannot simultaneously enable and disable the component or feature.
 |
NOTE: Although this section lists all possible omconfig commands, the commands available on your system depend on your system configuration. If you try to get help or execute a command for a component that is not installed on your system, Server Administrator issues a message that the component or feature is not "found on this system." |
|
NOTE: For Microsoft® Windows® systems, use Array Manager to configure an external chassis. See the Dell OpenManage Array Manager User's Guide for instructions. |
Table 7-1 is a high-level summary of the omconfig command. The columns titled "Command level 2" and "Command level 3" list the major arguments that can be used with omconfig. "User privilege required" refers to the type of privilege you need to perform the command, where U=User, P=Power User, and A=Administrator. "Use" is a very general statement about the actions that can be performed using omconfig. More details about syntax and use of the command appear later in this section.
Table 7-1. omconfig Command Level 1, Level 2, and Level 3
Use the omconfig -? command to get a list of the available commands for omconfig.
Use omconfig <command level 2> -? to get help on the level 2 commands about, chassis, and system. The following information on omconfig system -? applies equally to getting help for the omconfig chassis command.
Use the omconfig system -? command to get a list of the available commands for omconfig system.
Use a command of the form omconfig system <command level 3> -? to get a list of the parameters you must use to execute a particular omconfig system command. For example, the following commands produce a list of valid parameters for omconfig system alertaction and omconfig system shutdown:
omconfig system alertaction -?
omconfig system shutdown -?
In the case of the omconfig system alertaction command, you can use various options to prevent all of the CLI help from scrolling by before you can read it.
To scroll command output one screen at a time, type:
omconfig system alertaction -? | more
where | more allows you to press the spacebar to see the next screen of CLI help output.
To make a file that contains all of the help for the omconfig system alertaction -? command, type:
omconfig system alertaction -? -outa alert.txt
where -outa directs the output of the command to a file called alert.txt.
On a Microsoft® Windows® or Red Hat Linux operating system, you can read the help for alertaction command by typing:
more alert.txt
Use the omconfig about command to learn the product name and version number of the systems management application installed on your system. The following is example output from the omconfig about command:
Product name : Server Administrator
Version : 1.x.x
Copyright : Copyright (C) Dell Computer Corporation
1995-2003. All rights reserved.
Company : Dell Computer Corporation.
For even more details about the environment for Server Administrator, type:
omconfig about details=true
Server Administrator includes a number of services, each of which has a version number of its own. The Contains field reports version numbers for the services and provides other useful details. The output that follows is an example, and it can change depending on your configuration and the version of Server Administrator that is available:
Use the omconfig chassis commands to default or to set values for current, fan, voltage, and temperature probes, to configure BIOS behavior during system start up, to clear memory error counts, and to enable or disable power button control features where system configuration permits.
Use the omconfig chassis -? command to see a list of all omconfig chassis commands.
|
NOTE: When you issue CLI commands to a server module in a modular system, chassis refers only to the server module. |
Use the omconfig chassis acswitch command to configure how your system's power units respond to a failure in AC input. Table 7-2 shows the available configurations.
Table 7-2. AC Switch Redundancy Configurations
|
Command level 1 |
Command level 2 |
Command level 3 |
Name=value pair 1 |
Description |
|---|---|---|---|---|
Whether power unit redundancy is configured for this system. |
Use the omconfig chassis biossetup command to configure system BIOS settings that are normally available only in your system's BIOS setup boot time settings.
 |
NOTICE: Changing certain BIOS setup options might disable your system or require you to reinstall the operating system. |
|
NOTE: You must reboot your system before any changes to the BIOS setup options take effect. |
|
NOTE: Not all BIOS setup options are available on every system. |
Table 7-3 shows the name=value pairs you can use with this command.
Use the omconfig chassis currents command to set amperage probe warning thresholds. As with other components, you can view both warning and failure threshold values, but you cannot set failure thresholds. Your system's manufacturer sets the minimum and maximum failure thresholds.
|
NOTE: Settable thresholds vary from one system configuration to another. |
|
NOTE: Systems that contain embedded systems management 3 (ESM3) capabilities do not allow you to set warning threshold values to default values. |
Table 7-4 shows the valid parameters for setting current warning thresholds:
Table 7-4. omconfig chassis currents
|
Name=value pair |
Description |
|---|---|
If you want to set both the upper and lower current warning threshold values to the recommended default value, type:
omconfig chassis currents index=0 warnthresh=default
You cannot default one value and set another. In other words, if you default the minimum warning threshold value, you are also selecting the default value for the maximum warning threshold value.
If you prefer to specify values for the current probe warning thresholds, you must specify the number of the probe you are configuring and the minimum and/or maximum warning threshold values. In the following example, the probe that is being configured is probe 0:
omconfig chassis currents index=0 minwarnthresh=3.310 maxwarnthresh=3.381
When you issue the command and the system sets the values you specify, the following message appears:
Current probe warning threshold(s) set successfully.
Use the omconfig chassis fans command to set fan probe warning thresholds. As with other components, you can view both warning and failure threshold values, but you cannot set failure thresholds. Your system's manufacturer sets the minimum and maximum failure thresholds.
Table 7-5 shows the valid parameters for setting fan warning thresholds:
Table 7-5. omconfig chassis fans
|
Name=value pair |
Description |
|---|---|
|
NOTE: Systems that contain ESM3 capabilities do not allow you to set warning threshold values to default values. |
If you want to set both the upper and lower fan warning threshold values to the recommended default value, type:
omconfig chassis fans index=0 warnthresh=default
You cannot default one value and set another. In other words, if you default the minimum warning threshold value, you are also selecting the default value for the maximum warning threshold value.
If you prefer to specify values for the fan probe warning thresholds, you must specify the number of the probe you are configuring and the minimum and/or maximum warning threshold values. In the following example, the probe that is being configured is probe 0. The first command sets only the minimum threshold; the second sets minimum and maximum thresholds:
omconfig chassis fans index=0 minwarnthresh=3.31
omconfig chassis fans index=0 minwarnthresh=3.32 maxwarnthresh=3.38
When you issue the command and the system sets the values you specify, the following message appears:
Fan probe warning threshold(s) set successfully.
Use the omconfig chassis fancontrol command to set fan speed. You can optimize speed for cooling or for quiet operation. Table 7-6 shows the valid parameters for the command.
Table 7-6. omconfig chassis fancontrol
|
Name=value pair |
Description |
|---|---|
Use the omconfig chassis info command to enter an asset tag name for your system and a chassis name for your system. If your system is a modular one, you can enter asset tag names for modular components as well. Table 7-7 shows the valid parameters for the command.
Table 7-7. omconfig chassis info
|
Name=value pair |
Description |
|---|---|
Number of the chassis whose asset tag or name you are setting. | |
Asset tag in the form of alphanumeric text. Letters or numbers cannot exceed 10 characters. | |
In the example, the asset tag for the main system chassis is being set to buildsys:
omconfig chassis info index=0 tag=buildsys
Index 0 always defaults to main system chassis. The following command omits index=n, but accomplishes the same thing:
omconfig chassis info tag=buildsys
An acceptable command, when executed, results in the following message:
Chassis info set successfully.
For some chassis, you can assign a different name. You cannot rename the main system chassis. In the example below, the command renames chassis 2 from storscsi1 to storscsia:
omconfig chassis info index=2 name=storscsia
As with other commands, the CLI issues an error message if you do not have a chassis 2 (the main chassis=0). The CLI allows you to issue commands only for the system configuration you have.
Use the omconfig chassis leds command to specify when to flash a chassis fault LED or chassis identification LED and allow you to clear the LED for the system's hard drive. Table 7-8 shows the valid parameters for the command.
Table 7-8. omconfig chassis leds
|
Name=value pair 1 |
Name=value pair 2 |
Description |
|---|---|---|
Number of the chassis where the LED resides (defaults to chassis 0, main system chassis). | ||
Select to flash the LED either when a warning event occurs or when a critical event occurs. | ||
Set the number of faults for the hard drive back to zero (0). | ||
Use the omconfig chassis memorymode command to specify the redundancy mode you want to use for your system's memory in case of memory errors.
Redundant memory enables a system to switch to other available memory modules if unacceptable errors are detected in the modules it is currently using. The omconfig chassis memorymode command allows you to disable redundancy; when you disable redundancy, you instruct the system not to switch to other available memory modules when the module the system is using begins to encounter errors. If you want to enable redundancy, you must choose between spare bank and mirroring.
Spare bank mode disables a bank of system memory in which a single-bit ECC error is detected, enables the spare bank, and copies all the data from the original bank to the spare bank. Spare bank requires at least three banks of identical memory; the operating system does not recognize the spare bank.
Mirroring mode switches to a redundant copy of memory when a multibit error is detected. After switching to the mirrored memory, the system does not switch back to the original system memory until the next reboot. The operating system does not recognize half of the installed system memory in this mode.
Table 7-9 shows the valid parameters for the command.
Table 7-9. omconfig chassis memorymode
|
Name=value pair 1 |
Description |
|---|---|
Use this command to enable or to disable power button override on systems where this feature is present. Table 7-10 shows the valid parameters for the command.
Table 7-10. omconfig chassis powerbutton
|
Name=value pair 1 |
Description |
|---|---|
Use the omconfig chassis temps command to set warning thresholds for temperature probes. As with other components, you can view both warning and failure threshold values, but you cannot set failure thresholds. Your system's manufacturer sets the minimum and maximum failure thresholds.
|
NOTE: Settable thresholds vary from one system configuration to another. |
Table 7-11 shows the valid parameters for setting temperature warning thresholds:
Table 7-11. omconfig chassis temps
|
Name=value pair |
Description |
|---|---|
|
NOTE: Systems that contain ESM3 capabilities do not allow you to set warning threshold values to default values. |
If you want to set both the upper and lower temperature warning threshold values to the recommended default value, type:
omconfig chassis temps index=0 warnthresh=default
You cannot default one value and set another. In other words, if you default the minimum warning threshold value, you are also selecting the default value for the maximum warning threshold value.
If you prefer to specify values for the temperature probe warning thresholds, you must specify the number of the probe you are configuring and the minimum and/or maximum warning threshold value. In the following example, the probe that is being configured is probe 4:
omconfig chassis temps index=4 minwarnthresh=11.2 maxwarnthresh=58.7
When you issue the command and the system sets the values you specify, the following message appears:
Temperature probe warning threshold(s) set successfully.
Use the omconfig chassis volts command to set voltage probe warning thresholds. As with other components, you can view both warning and failure threshold values, but you cannot set failure thresholds. Your system's manufacturer sets the minimum and maximum failure thresholds.
Table 7-12 shows the valid parameters for setting voltage warning thresholds.
|
NOTE: Settable thresholds vary from one system configuration to another. |
Table 7-12. omconfig chassis volts
|
Name=value pair |
Description |
|---|---|
|
NOTE: Systems that contain ESM3 capabilities do not allow you to set warning threshold values to default values. |
If you want to set both the upper and lower voltage warning threshold values to the recommended default value, type:
omconfig chassis voltage index=2 warnthresh=default
You cannot default one value and set another. In other words, if you default the minimum warning threshold value, you are also selecting the default value for the maximum warning threshold value.
If you prefer to specify values for the voltage probe warning thresholds, you must specify the number of the probe you are configuring and the minimum and/or maximum warning threshold values. In the following example, the probe that is being configured is probe 0:
omconfig chassis volts index=0 minwarnthresh=1.900 maxwarnthresh=2.250
When you issue the command and the system sets the values you specify, the following message appears:
Voltage probe warning threshold(s) set successfully.
Use the omconfig preferences command to set system preferences. On the command line, you can set the SNMP root password and specify which user levels are able to access Server Administrator.
Setting the SNMP root password allows administrators to restrict access to SNMP set operations that allow important systems management interventions. You can configure the SNMP root password normally (by typing all of the parameters in one command line) or interactively.
|
NOTICE: Interactive mode is the more secure method of setting the SNMP root password. In noninteractive mode, the values you enter for the newpw and confirmnewpw options appear on your system's monitor when you type them. In interactive mode, the values you type for passwords are masked. |
The parameters for configuring the SNMP root password are the same whether you configure it interactively or iteratively.
|
NOTE: If you specify setting=rootpw but do not specify the other name=value pair parameters, you enter interactive mode, and the command line prompts you for the remaining values. |
Table 7-13 shows the valid parameters for the command.
Table 7-13. SNMP Root Password Parameters
|
Name=value pair |
Description |
|---|---|
When you type omconfig preferences snmp setting=rootpw, the system prompts you to supply values for the required parameters.
When you type omconfig preferences snmp, you must supply all of the parameters in the initial command line. For example:
omconfig preferences snmp setting=rootpw oldpw=openmanage newpw=serveradmin confirmnewpw=serveradmin
Depending on the policies of your enterprise, you may want to restrict the access that some user levels have to Server Administrator. The omconfig preferences useraccess command allows you to grant or withhold the right of Users and Power Users to access Server Administrator. Table 7-14 shows the valid parameters for the command.
Table 7-14. Enabling User Access for Administrators, Power Users, and Users
|
Command |
Result |
Description |
|---|---|---|
Grants Server Administrator access to Users, Power Users, and Administrators. | ||
Grants Server Administrator access to Power Users and Administrators. | ||
Use the omconfig system commands to clear logs, determine how various shutdown actions occur, set initial values or edit values for cost of ownership information, and determine how to respond to a hung operating system.
You can use the omconfig system alertaction command to determine how Server Administrator responds when a component has a warning or failure event.
An alert action is an action that you can specify for your system to take when specified conditions are met. Alert actions determine in advance what actions are to be taken for warning or failure events on intrusion, fans, temperatures, voltages, power supplies, memory, and redundancy.
For example, if a fan probe on your system reads a fan RPM of 300 and your minimum warning threshold value for that fan probe is 600 RPM, then your system generates a fan probe warning. Alert action settings determine how persons are notified of this event. For temperature, voltage, and current probe readings that fall within the warning or failure range, you can also configure alert actions.
Setting an alert action requires two name=value pairs. The first name=value pair is the event type. The second name=value pair is the action you want to take for this event. For example, in the command:
omconfig system alertaction event=powersupply broadcast= true
the event is a power supply failure and the action is to broadcast a message to all Server Administrator users.
Table 7-15 shows the alert actions for each component that allows you to configure an alert action.
Table 7-15. Alert Actions You Can Set for Warning and Failure Events
|
Alert Action Setting |
Description |
|---|---|
true: Enable a message or alert to be broadcast to all users that have drives mapped to the system. | |
Set all actions for this event to the default for events of this type. | |
Table 7-16 lists the components and the events for which you can set alert actions. Components are listed in alphabetical order, except that warning events always precede failure events for a component.
Table 7-16. Events for Which You Can Set Alert Actions
|
Event Name |
Description |
|---|---|
Set actions when a temperature probe detects a warning value. | |
Set actions when a temperature probe detects a failure value. | |
The examples below are valid example commands. For each successful command issued, the following message appears:
Alert action(s) configured successfully.
To disable system speaker beeping if a current probe detects a warning event, type:
omconfig system alertaction event=currentwarn beep=false
To enable broadcast messages if a current probe detects a failure event, type:
omconfig system alertaction event=currentfail broadcast= true
To set fan warning alert actions to default, type:
omconfig system alertaction event=fanwarn defaultall=true
To generate alerts when a fan probe detects a failure value, type:
omconfig system alertaction event=fanfail alert=true
To clear all alert actions for chassis intrusion, type:
omconfig system alertaction event=intrusion clearall=true
|
NOTE: For more information about alert messages, see the Dell OpenManage Server Administrator Messages Reference Guide. |
You can use the omconfig system command to clear three logs: the alert log, the command log, and the hardware, or ESM, log.
To clear the contents of the alert log, type:
omconfig system alertlog action=clear
|
NOTE: Entering an invalid RAC user name may prevent the command log from displaying. Clearing the command log resolves this condition. |
To clear the contents of the command log, type:
omconfig system cmdlog action=clear
To clear the contents of the ESM log, type:
omconfig system esmlog action=clear
Use the omconfig system events command to enable and disable SNMP traps for components on your system.
|
NOTE: Not all event types may be present on your system. |
There are four parameters in the name=value pair component of the omconfig system events command:
At present, source=snmptraps is a required name=value pair because SNMP is currently the only supported source of event notification for your system's components.
omconfig system events source=snmptraps
The event type refers to the name of the component(s) involved in the event. Table 7-17 shows the valid parameters for system event types.
Table 7-17. System Event Type Parameters
|
Name=value pair |
Description |
|---|---|
In the context of configuring events, severity determines how severe an event must be before Server Administrator notifies you of the event for a component type. When there are multiple components of the same type in the same system chassis, you can also specify whether you want to be notified for event severity according to the number of the component by using the index=<n> parameter. Table 7-18 shows the valid severity parameters.
Table 7-18. System Event Severity Parameters
|
Command |
Result |
Description |
|---|---|---|
Enables notification for informational, warning, and critical events. | ||
omconfig system events type=<component name> severity=warning | Omits informational event notification, for example, when a component returns to normal status. | |
omconfig system events type=<component name> severity=critical | ||
Index refers to the number of an event for a particular component. Index is an optional parameter. When you omit the index parameter, events are configured for all components of the specified type, such as all fans. When a system contains more than one fan, for example, you can enable or disable event notification for a particular fan. An example command is as follows:
omconfig system events type=fan index=0 severity=critical
As a result of the example command, Server Administrator will send an SNMP trap only when the first fan in the system chassis (index 0) has reached critical fan RPMs.
Use the omconfig system webserver command to start or stop the Web server. Table 7-19 shows the valid parameters for the command.
Table 7-19. Web Server Configuration Parameters
|
Name=value pair |
Description |
Use the omconfig system recovery command to set the action that is to be taken when the operating system has hung or crashed. You can also set the number of seconds that must pass before the system is considered to have a hung operating system. Table 7-20 shows the valid parameters for the command.
|
NOTE: Upper and lower limits for the timer are dependent on your system model and configuration. |
Table 7-20. Recovery Parameters
|
Name=value pair |
Description |
Take no action when the operating system is hung or has crashed. | |
To set the action on hung operating system detection to powercycle, type:
omconfig system recovery action=powercycle
To set the amount of time that the system must be hung before a recovery action is initiated to 120 seconds, type:
omconfig system recovery timer=120
Use the omconfig system shutdown command to determine how the system shuts down. During system shutdown, the default is to shut down the operating system before powering off the system. Shutting down the operating system first closes down the file system before powering the system down. If you do not want to shut down the operating system first, you can use the parameter osfirst=false. Table 7-21 shows the valid parameters for the command.
Table 7-21. Shutdown Parameters
|
Name=value pair |
Description |
|---|---|
Close the file system and exit the operating system before shutting down the system. |
To set the shutdown action to reboot, type:
omconfig system shutdown action=reboot
To bypass operating system shutdown before the system is powered off, type:
omconfig system shutdown action=reboot osfirst=false
Use the omconfig system thrmshutdown command to configure a thermal shutdown action. A thermal shutdown can be configured to occur when a temperature probe detects a temperature probe warning or failure event. Table 7-22 shows the valid parameters for the command.
Table 7-22. Thermal Shutdown Parameters
|
Name=value pair |
Description |
disabled: Disable thermal shutdown. An administrator must intervene. failure: Perform a shutdown when a temperature failure event is detected. |
To trigger a thermal shutdown when a temperature probe detects a failure event, type:
omconfig system thrmshutdown severity=failure
To disable thermal shutdown so that an administrator has to initiate an omconfig system shutdown, type:
omconfig system thrmshutdown severity=disabled