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.
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."
Conventions for Parameter Tables
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.
omconfig Command Summary
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 6-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.
Shows version number and properties for the Server Administrator program.
details=true
U, P, A
Displays information for all of the Server Administrator programs that are installed.
preferences
cdvformat
A
Specifies the delimiter for separating data fields reported in custom delimited format (cdv).
dirservice
A
Configures the Active Directory service.
snmp
A
Sets the SNMP root password.
useraccess
A
Determines whether users below the administrator level are allowed to use Server Administrator or not.
system
alertaction
P, A
Determines in advance what actions are to be taken for warning or failure events on intrusion, fans, temperatures, voltages, power supplies, memory, and redundancy.
alertlog
P, A
Allows the administrator to clear the log.
assetinfo
P, A
Enters and edits cost of ownership information for your system, including values for depreciation, lease, maintenance, service, and support.
cmdlog
P, A
Allows the administrator to clear the log.
esmlog
P, A
Allows the administrator to clear the log.
events
P, A
Enables and disables SNMP traps.
pedestinations
P, A
Sets IP addresses for alert destinations.
platformevents
A
Determines the shutdown action, if any, to be taken for a specific platform event. Also, enables and disables platform events filter alert generation.
recovery
P, A
Determines in advance how your system responds to a hung operating system.
shutdown
A
Allows the administrator to select from several options when shutting down the system.
thrmshutdown
A
Sets the severity level at which a thermal event triggers a system shutdown.
webserver
A
Starts or stops the Web server.
chassis
biossetup
A
Configures behavior of specific system components that are controlled by the BIOS.
bmc
P, A
Configures the baseboard management controller (BMC).
currents
P, A
Configures current probe warning thresholds by default or by value.
fans
P, A
Configures fan probe warning thresholds by default or by value.
NOTE: You cannot set warning threshold values
by default on embedded server management
(ESM3) systems.
fancontrol
P, A
Allows you to optimize fan speed for maximum cooling or quiet operation.
frontpanel
A
Configures the Power button and Nonmasking Interrupt (NMI) button if present on the system.
info
P, A
Allows you to set an initial value for, or to edit the value for, asset tag or chassis name.
leds
P, A
Specifies when to flash a chassis fault LED or chassis identification LED, and allows you to clear the LED for the system's hard drive.
memorymode
A
Enables or disables the spare bank and mirroring memory modes, and also specify which mode to use.
temps
P, A
Sets warning threshold values by default or value.
NOTE: You cannot set warning threshold values
by default on ESM3 systems.
volts
P, A
Sets warning threshold values by default or value.
NOTE: You cannot set warning threshold values
by default on ESM3 systems.
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, preferences, 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 the omconfig preferences -? command to get a list of the available commands for omconfig preferences, such as cdvformat, which is the custom delimiter format (cdv). Type the following command to display the list of delimiter values for the cdv:
omconfig preferences cdvformat -?
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 omconfigsystem command. For example, the following commands produce a list of valid parameters for omconfigsystemalertaction and omconfigsystemshutdown:
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.
To read the help for the alertaction command on a Microsoft® Windows® or Red Hat® Enterprise Linux operating system, type:
more alert.txt
omconfig about
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 : 2.x.x Copyright : Copyright (C) Dell Inc.
1995-2005. All rights reserved.
Company : Dell Inc.
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:
Contains:
Instrumentation Service 5.x.x
Storage Management Service 3.x.x
Diagnostic Service 2.x.x
Sun JRE - OEM Installed Version 3.x.x
Secure Port Server 1.x.x
Core Service 1.x.x
Instrumentation Service Integration Layer 1.x.x
Storage Management Service Integration
Layer 1.x.x
Server Administrator 2.x.x
omconfig chassis
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 omconfigchassis commands.
NOTE: When you issue CLI commands to a server module in a modular system, chassis refers only to the
server module.
omconfig chassis biossetup
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 6-2 shows the name=value pairs you can use with this command.
Table 6-2. BIOS Setup
name=value pair 1 attribute=
name=value pair 2 setting=
Description
attribute=acpwrrecovery
setting=off | last | on
off: System is turned off.
last: System returns to previous state.
on: System is turned on.
attribute=bezel
setting=enable | disable
enable: Enable the bezel removal intrusion check during system boot.
disable: Disable the bezel removal intrusion check during system boot.
onpxenone: PXE is not enabled on either of the NICs.
onpxenic1: PXE is enabled on NIC 1.
onpxenic2: PXE is enabled on NIC 2.
attribute=fbr
setting=9600 | 19200 | 57600 | 115200
9600: Sets the console redirection failsafe baud rate to 9600 bits per second.
19200: Sets the console redirection failsafe baud rate to 19200 bits per second.
57600: Sets the console redirection failsafe baud rate to 57600 bits per second.
115200: Sets the console redirection failsafe baud rate to 115200 bits per second.
attribute=ide
setting=on | off force=true
on: Enable this device.
off: Disable this device.
force=true: Verification of setting change.
attribute=idepridrv
setting=off | auto
off: Disable the device.
auto: Automatically detect and enable the device.
attribute=intrusion
setting=enable | disable
enable: Enable the intrusion check during system boot. If the system also has bezel intrusion checking, then the intrusion option checks for removal of the back of the system.
disable: Disable the intrusion check during system boot.
attribute=mouse
setting=on | off
on: Enable the mouse.
off: Disable the mouse.
attribute=nic
setting=enabled | disabled | enablednonepxe
enabled: Enable the NIC during system boot (with PXE on if the system has PXE).
disabled: Disable the NIC during system boot.
enablednonepxe: Enable the NIC during system boot (with PXE off if the system has PXE).
attribute=nic2
setting=enabled | disabled | enablednonepxe
enabled: Enable the second NIC during system boot (with PXE on if the system has PXE).
disabled: Disable the second NIC during system boot.
enablednonepxe: Enable the second NIC during system boot (with PXE off if the system has PXE)S.
attribute=numlock
setting=on | off
on: Use the keypad as number keys.
off: Use the keypad as arrow keys.
attribute=ppaddress
setting=off | lpt1 | lpt2 | lpt3
off: Disable the parallel port address.
lpt1: Locate the device on LPT1.
lpt2: Locate the device onLPT2.
lpt3: Locate the device on LPT3.
attribute=ppmode
setting=at | ps2 | ecp | epp
at: Set the parallel port mode to type AT.
ps2: Set the parallel port mode to type PS/2.
ecp: Set the parallel port mode to type ECP (extended capabilities port).
epp: Set the parallel port mode to type EPP (enhanced parallel port).
attribute=primaryscsi
setting=on | off force=true
NOTICE: If you modify the setting for
primary scsi, romb, romba, or rombb, your
system becomes inoperable until you
reinstall the operating system.
on: Enable this device.
off: Disable this device.
force=true: Verification of setting change.
attribute=romb
setting=raid | off | scsi
force=true
raid: Instructs the BIOS to detect RAID-on-motherboard as a RAID device.
off: Disable the device during system boot.
scsi: Instructs the BIOS to detect this device as a SCSI device.
force=true: Verification of setting change.
attribute=romba
setting=raid | scsi
force=true
raid: Instructs the BIOS to detect RAID-on-motherboard channel A as a RAID device.
scsi: Instructs the BIOS to detect this device as a SCSI device.
force=true: Verification of setting change.
attribute=rombb
setting=raid | scsi
force=true
raid: Instructs the BIOS to detect RAID-on-motherboard channel B as a RAID device.
scsi: Instructs the BIOS to detect this device as a SCSI device.
force=true: Verification of setting change.
attribute=sata
setting=off| ata | raid
off: Disables SATA controller.
ata: Sets the onboard SATA controller to ATA mode.
raid: Sets the onboard SATA controller to RAID mode.
NOTE: Only one of the two attributes usb
and usbb is available for configuring the
USB port(s), depending on your system's
hardware.
enabled: Enable the USB port(s).
disabled: Disable the USB port(s).
attribute=usbb
setting=enabled | enabledwithbios| disabled
enabled: Enable the USB port(s) during system boot, without BIOS support.
enabledwithbios: Enable the USB port(s) during the system boot, with BIOS support.
disabled: Disable the USB port(s) during system boot.
omconfig chassis bmc
Use the omconfig chassis bmc command to configure:
The BMC on a local area network (LAN)
The serial port for BMC
The BMC on a serial over LAN connection
Terminal settings for the serial port
Advanced settings for a serial over LAN connection
Information on a BMC user
NOTE: You have to enter the user ID to configure user information.
Type:
omconfig chassis bmc
The output from the omconfig chassis bmc command lists each of the available configurations. Table 6-3 shows the valid parameters:
Table 6-3. omconfig chassis bmc
name=value pair 1 config=
name=value pair 2
Description
config=advsol
characcuminterval=number
number: Sets the character accumulate interval in 5 millisecond intervals.
config=advsol (continued)
charsendthreshold=number
number: Sets the number of characters. BMC automatically sends a serial over LAN data packet that contains this number of characters as soon as this number of characters (or greater) has been accepted from the baseboard serial controller into the BMC.
config=nic
enable=true | false
true: Enables IPMI over LAN.
false: Disables IPMI over LAN.
config=nic (continued)
gateway=Gateway
gateway: Sets a gateway address if you have selected static as the IP address source for the BMC LAN interface.
config=nic (continued)
IP address=IP
ip: Sets the IP address if you have selected static as the IP address source for the BMC LAN interface.
config=nic (continued)
ipsource=static | dhcp | systemsoftware
static: Static if the IP address of the BMC LAN interface is a fixed, assigned IP address.
dhcp: DHCP if the source of the IP address of the BMC LAN interface is the dynamic host configuration protocol.
systemsoftware: System software if the source of the IP address of the BMC LAN interface is from the system software.
NOTE: Not all commands may be
supported on the system.
config=nic (continued)
privilegelevel=administrator | operator | user
administrator: Sets the maximum privilege level that can be accepted on a LAN channel to Administrator.
operator: Sets the maximum privilege level that can be accepted on a LAN channel to Operator.
user: Sets the maximum privilege level that can be accepted on a LAN channel to User.
config=nic (continued)
subnet=Subnet
subnet: Sets a subnet mask if you have selected static as the IP address source for the BMC LAN interface.
config=nic (continued)
vlanenable=true | false
true: Enables the virtual LAN identification.
false: Disables the virtual LAN identification.
config=nic (continued)
vlanid=number
number: Virtual LAN identification in the range of 1 to 4094.
config=nic (continued)
vlanpriority=number
number: Priority of virtual LAN identification in the range of 0 to 7.
config=serial
baudrate=9600 | 19200 | 38400 | 57600
9600: Sets connection speed to 9600 bits per second.
19200:Sets connection speed to 19200 bits per second.
38400: Sets connection speed to 38400 bits per second.
57600: Sets connection speed to 57600 bits per second.
config=serial (continued)
flowcontrol=none | rtscts
none: No control over the flow of communication through the serial port.
rtscts: RTS is ready to send and CTS is clear to send.
id=number: ID number of the user being configured.
lanaccesslevel=administrator: User with an ID has access privileges of an Administrator for the LAN channel.
lanaccesslevel=operator: User with an ID has access privileges of an Operator for the LAN channel.
lanaccesslevel=user: User with an ID has access privileges of a User for the LAN channel.
lanaccesslevel=none: User with an ID does not have access privileges for the LAN channel.
omconfig chassis currents
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.
Valid Parameters for Current Warning Thresholds
Table 6-4 shows the valid parameters for setting current warning thresholds:
NOTE: The index parameter is optional. If you do not specify the index, Server Administrator displays a
summary of status, readings, and thresholds set for all current probes present on your system. "Current
probes are not present in all systems". If you specify the index, Server Administrator displays a summary
for a specific current probe.
Table 6-4. omconfig chassis currents
name=value pair
Description
index=<n>
Number of the probe or probe index (must be specified).
warnthresh=default
Sets minimum and maximum warning thresholds to default.
minwarnthresh=<n>
Minimum warning threshold (3 decimal places).
maxwarnthresh=<n>
Maximum warning threshold (3 decimal places).
Default Minimum and Maximum Warning Thresholds
If you want to set both the upper and lower current warning threshold values to the recommended default value, type:
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.
Specify a Value for Minimum and Maximum Warning Thresholds
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:
When you issue the command and the system sets the values you specify, the following message appears:
Current probe warning threshold(s) set successfully.
omconfig chassis fans
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.
Valid Parameters for Fan Warning Thresholds
Table 6-5 shows the valid parameters for setting fan warning thresholds:
Table 6-5. omconfig chassis fans
name=value pair
Description
index=<n>
Number of the probe or probe index (must be specified).
warnthresh=default
Sets minimum and maximum warning thresholds to default.
minwarnthresh=<n>
Minimum warning threshold.
maxwarnthresh=<n>
Maximum warning threshold.
Default Minimum and Maximum Warning Thresholds
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.
Specify a Value for Minimum and Maximum Warning Thresholds
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:
When you issue the command and the system sets the values you specify, the following message appears:
Fan probe warning threshold(s) set successfully.
omconfig chassis fancontrol
Use the omconfig chassis fancontrol command to set fan speed. You can optimize speed for cooling or for quiet operation. Table 6-6 shows the valid parameters for the command.
Table 6-6. omconfig chassis fancontrol
name=value pair
Description
speed=quiet
Sets fan speed for quiet operation.
speed=maxcool
Sets fan speed for maximum cooling.
omconfig chassis frontpanel
Use the omconfig chassis frontpanel command to configure the Power button and the Nonmasking Interrupt (NMI) button.
NOTE: The Power and NMI buttons can be configured only if present on the system.
Table 6-7 shows the valid parameters for the command.
Table 6-7. omconfig chassis frontpanel
Subcommand
name=value pair
Description
nmibutton
enable=true | false
true: Enables the NMI button on the system.
false: Disables the NMI button on the system.
powerbutton
enable=true | false
true: Enables the Power button on the system.
false: Disables the Power button on the system.
omconfig chassis info
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 6-8 shows the valid parameters for the command.
Table 6-8. omconfig chassis info
name=value pair
Description
index=<n>
Number of the chassis whose asset tag or name you are setting.
tag=<text>
Asset tag in the form of alphanumeric text. Letters or numbers cannot exceed 10 characters.
name=<text>
Name of the chassis.
In the following 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.
omconfig chassis leds
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 6-9 shows the valid parameters for the command.
Table 6-9. omconfig chassis leds
name=value pair 1
name=value pair 2
Description
index=<n>
NA
Number of the chassis where the LED resides (defaults to chassis 0, main system chassis).
led=fault
severity=warning | critical
Select to flash the LED either when a warning event occurs or when a critical event occurs.
led=hdfault
action=clear
Sets the number of faults for the hard drive back to zero (0).
led=identify
flash=off | on
time-out=<n>
Sets the chassis identification LED to off or on. Set the time-out value for the LED to flash to a number of seconds.
omconfig chassis memorymode
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 correctable memory event 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 an
uncorrectable memory event 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 6-10 shows the valid parameters for the command.
Table 6-10. omconfig chassis memorymode
name=value pair 1
Description
index=<n>
Number of the chassis where the memory module resides (the default is chassis 0, the main system chassis).
redundancy=spare | mirrored | disabled | raid5
Spare disables the memory module that has a
correctable memory event and copies the failing module's data to a spare bank. Disabled indicates that the system is not to use other available memory modules if
uncorrectable memory events are detected. Mirrored switches the systems to a mirrored copy of the memory if the failing module has an
uncorrectable memory event. In mirrored mode, the operating system does not switch back to the original module until the system reboots. RAID5 is a method of system memory configuration. This is logically similar to the RAID5 mode used in hard drive storage systems. This memory mode gives you an extra level of memory checking and error recovery at the expense of some memory capacity. The RAID mode supported is RAID level 5 striping with rotational parity.
omconfig chassis temps
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.
Valid Parameters for Temperature Warning Thresholds
Table 6-11 shows the valid parameters for setting temperature warning thresholds:
Table 6-11. omconfig chassis temps
name=value pair
Description
index=<n>
Number of the probe or probe index (must be specified).
warnthresh=default
Sets minimum and maximum warning thresholds to default.
minwarnthresh=<n>
Minimum warning threshold (1 decimal place).
maxwarnthresh=<n>
Maximum warning threshold (1 decimal place).
Default Minimum and Maximum Warning Thresholds
NOTE: The capabilities for managing sensors vary by systems.
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.
Specify a Value for Minimum and Maximum Warning Thresholds
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.
omconfig chassis volts
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.
Valid Parameters for Voltage Warning Thresholds
Table 6-12 shows the valid parameters for setting voltage warning thresholds.
NOTE: Settable thresholds vary from one system configuration to another.
Table 6-12. omconfig chassis volts
name=value pair
Description
index=<n>
Probe index (must be specified).
warnthresh=default
Sets minimum and maximum warning thresholds to default.
minwarnthresh=<n>
Minimum warning threshold (3 decimal places).
maxwarnthresh=<n>
Maximum warning threshold (3 decimal places).
Default Minimum and Maximum Warning Thresholds
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.
Specify a Value for Minimum and Maximum Warning Thresholds
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:
When you issue the command and the system sets the values you specify, the following message appears:
Voltage probe warning threshold(s) set successfully.
omconfig preferences
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. You can also configure the Active Directory service.
omconfig preferences cdvformat
You can use the omconfig preferences cdvformat to specify the delimiters for separating data fields reported in the custom delimited format. The valid values for delimiters are: exclamation, semicolon, at, hash, dollar, percent, caret, asterisk, tilde, question, colon, comma, and pipe.
The following example shows how to set the delimiter for separating data fields to asterisk:
omconfig preferences cdvformat delimiter=asterisk
omconfig preferences dirservice
You can use the omconfig preferences dirservice command to configure the Active Directory service. The <productname>oem.ini file is modified to reflect these changes. If the "adproductname" is not present in the <productname>oem.ini file then a default value will be used. The default value will be <computername><productname>, where <computername> refers to the name of the computer running Server Administrator and <productname> refers to the name of the product defined in omprv32.ini. For Server Administrator, it is "omsa".
Therefore, for a computer named "myOmsa" running Server Administrator, the default name would be "myOmsaomsa". This is the name of Server Administrator defined in Active Directory by using the snapin tool. This name must match the name for the application object in Active Directory in order to find user privileges.
NOTE: This command is applicable only on systems running the Windows operating system.
Table 6-13 shows the valid parameters for the command.
Table 6-13. Active Directory Service Configuration Parameters
name=value pair
Description
prodname=<text>
Specify the product to which you want to apply the Active Directory configuration changes. Prodname refers to the name of the product defined in omprv32.ini. For Server Administrator, it is "omsa".
enable=<true | false>
true: Enables Active Directory service authentication support and the Active Directory Login option on the login page.
false: Disables Active Directory service authentication support and the Active Directory Login option on the login page. If the Active Directory Login option is not present, you can only login to the local machine accounts.
adprodname=<text>
Specify the name of the product as defined in the Active Directory service. This name links the product with the Active Directory privilege data for user authentication.
omconfig preferences snmp
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 6-14 shows the valid parameters for the command.
Table 6-14. SNMP Root Password Parameters
name=value pair
Description
setting=rootpw
Required.
oldpw=<oldpassword>
Enter the old SNMP root password.
newpw=<newpassword>
Sets the new SNMP root password.
confirmnewpw=<newpassword>
Confirms the new SNMP root password.
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:
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 6-15 shows the valid parameters for the command.
Table 6-15. Enabling User Access for Administrators, Power Users, and Users
Command
Result
Description
omconfig preferences useraccess enable=user
Grants Server Administrator access to Users, Power Users, and Administrators.
Least restrictive form of user access.
omconfig preferences useraccess enable=poweruser
Grants Server Administrator access to Power Users and Administrators.
Excludes user level access only.
omconfig preferences useraccess enable=admin
Grants Server Administrator access to Administrators only.
Most restrictive form of user access.
omconfig system
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.
omconfig system alertaction
You can use the omconfig system alertaction command to determine how Server Administrator responds when a component has a warning or failure event.
Defining Alert Actions
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.
Syntax for Setting 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.
Available Alert Actions
Table 6-16 shows the alert actions for each component that allows you to configure an alert action.
Table 6-16. Alert Actions You Can Set for Warning and Failure Events
Alert Action Setting
Description
beep=true | false
true: Enables your system's beep speaker. When enabled, the speaker on the system from which you are running Server Administrator beeps.
false: Disables your system's beep speaker.
alert=true | false
true: Enables your system's console alert. When enabled, the monitor attached to the system from which you are running Server Administrator displays a visual alert message.
false: Disables your system's console alert.
broadcast=true | false
true: Enables a message or alert to be broadcast to all users that have drives mapped to the system.
false: Disables alert broadcasts.
clearall=true
Clears all actions for this event.
defaultall =true
Sets all actions for this event to the default for events of this type.
execappath
Sets the fully qualified path and filename of the application you want to execute in case of an event for the component described in this window.
execapp=false
Disables the executable application.
Components and Events for Which You Can Set Alert Actions
Table 6-17 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 6-17. Events for Which You Can Set Alert Actions
Event Name
Description
event=currentwarn
Sets actions when a current probe detects a warning value.
event=currentfail
Sets actions when a current probe detects a failure value.
event=fanwarn
Sets actions when a fan probe detects a warning value.
event=fanfail
Sets actions when a fan probe detects a failure value.
event=hardwarelogwarn
Sets actions when a hardware log detects a warning value.
event=hardwarelogfull
Sets actions when a hardware log is full.
event=intrusion
Sets actions when a chassis intrusion event is detected.
event=memprefail
Sets actions when a memory probe detects a prefailure value.
event=memfail
Sets actions when a memory probe detects a failure value.
event=powersupply
Sets actions when a power supply probe detects a failure value.
event=powersupplywarn
Sets actions when a power supply probe detects a warning value.
event=processorwarn
Sets actions when a processor probe detects a warning value.
event=processorfail
Sets actions when a processor probe detects a failure value.
event=redundegrad
Sets actions when a redundant component becomes inoperative, resulting in less than full redundancy for that component.
event=redunlost
Sets actions when one or more redundant components become inoperative, resulting in a lost or a "no redundant components working" condition for that component.
event=tempwarn
Sets actions when a temperature probe detects a warning value.
event=tempfail
Sets actions when a temperature probe detects a failure value.
event=voltwarn
Sets actions when a voltage probe detects a warning value.
event=voltfail
Sets actions when a voltage probe detects a failure value.
event=watchdogasr
Sets actions when a watchdog Automatic System Recovery (ASR) detects a value.
Example Set Alert Action Commands
The examples below are valid example commands. For each successful command issued, the following message appears:
Alert action(s) configured successfully.
Example Current Probe Actions
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
Example Fan Probe Actions
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
Example Chassis Intrusion Actions
To clear all alert actions for chassis intrusion, type:
omconfig system alertaction event=intrusion clearall=true
Commands for Clearing Logs
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
omconfig system pedestinations
Use the omconfig system pedestinations command to set IP addresses for alert destinations.
Table 6-18 shows the valid parameters for the command.
NOTE: You can either specify the index and IP address as parameters together OR you can set the
community string as a parameter alone.
Table 6-18. omconfig system pedestinations
name=Value Pair
Description
destenable=true | false
true: Enables an individual platform event filter destination after a valid IP address has been set.
false: Disables an individual platform event filter.
index=number
Sets the index for the destination.
ipaddress=ip address
Sets the IP address for the destination.
communitystr=text
Sets the text string that acts as a password and is used to authenticate SNMP messages sent between the BMC and the destination management station.
omconfig system platformevents
Use the omconfig system platformevents command to configure shutdown action, if any, to be taken for a specific platform event. You can also enable or disable platform event filter alert generation.
NOTICE: If you set a platform event shutdown action to anything other than "none", your system will
forcefully shutdown when the specified event occurs. This shutdown is initiated by firmware and is
carried out without first shutting down the operating system or any of the applications running on
your system.
Table 6-19 shows the valid parameters for the command.
NOTE: Alert settings are mutually exclusive and can be set one at a time only. The action settings are
also mutually exclusive and can be set one at a time only. However, alert and action settings are not
mutually exclusive of each other.
Table 6-19. Shutdown Action
Shutdown Action
Description
alert=disable
Disables the SNMP alert.
alert=enable
Enables the SNMP alert to be sent.
action=none
Takes no action when the system is hung or has crashed.
action=powercycle
Turns the electrical power to the system off, pauses, turns the power on, and reboots the system.
action=poweroff
Turns off the electrical power to the system.
action=reboot
Forces the operating system to shut down and initiates system startup, performs BIOS checks, and reloads the operating system.
Table 6-20 lists the components and the events for which you can set platform events. Components are listed in alphabetical order, except that warning events always precede failure events for a component.
NOTE: This setting is independent of the individual platform event filter
alert settings. For a platform event filter to generate an alert, both the
individual alert and the global event alert must be enabled.
event=discretevol
Sets action or enables/disables alert generation when a discrete voltage probe detects that the voltage is too low for proper operation.
event=fanfail
Sets action or enables/disables alert generation when a fan probe detects that the fan is running too slow or not at all.
event=hardwarelogfail
Enables/disables alert generation when a hardware log detects a failure value.
event=intrusion
Sets action or enables/disables alert generation when a chassis has been opened.
event=powerwarn
Sets action or enables/disables alert generation when a power device probe detects that the power supply, voltage regulator module, or DC to DC converter is pending a failure condition.
event=powerfail
Sets action or enables/disables alert generation when a power device probe detects that the power supply, voltage regulator module, or DC to DC converter has failed.
event=processorwarn
Sets action or enables/disables alert generation when a processor probe detects that the processor is running at less than peak performance or speed.
event=processorfail
Sets action or enables/disables alert generation when a processor probe detects that the processor has failed.
event=redundegrad
Sets action or enables/disables alert generation when the system's fans and/or power supplies become inoperative, resulting in less than full redundancy for that component.
event=redunlost
Sets action or enables/disables alert generation when the system's fans and/or power supplies become inoperative, resulting in a lost or a "no redundant components working" condition for that component.
event=tempwarn
Sets action or enables/disables alert generation when a temperature probe detects that the temperature is approaching the maximum high or low limits.
event=tempfail
Sets action or enables/disables alert generation when a temperature probe detects that the temperature is either too high or low for proper operation.
event=voltfail
Sets action or enables/disables alert generation when a voltage probe detects that the voltage is too low for proper operation.
event=watchdogasr
Enables or disables alert generation configured by the ASR when the system has hung or is not responding.
omconfig system events
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:
source
type
severity
index
Source
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
Type
The event type refers to the name of the component(s) involved in the event. Table 6-21 shows the valid parameters for system event types.
Table 6-21. System Event Type Parameters
name=value pair
Description
type=accords
Configures events for AC power cords.
type=all
Configures events for all device types.
type=currents
Configures events for amperage.
type=fanenclosures
Configures events for fan enclosures.
type=fans
Configures events for fans.
type=intrusion
Configures events for chassis intrusion.
type=log
Configures events for logs.
type=memory
Configures events for memory.
type=powersupplies
Configures events for power supplies.
type=redundancy
Configures events for redundancy.
type=temps
Configures events for temperatures.
type=volts
Configures events for voltages.
Severity
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 6-22 shows the valid severity parameters.
Table 6-22. System Event Severity Parameters
Command
Result
Description
omconfig system events type=<componentname> severity=info
Enables notification for informational, warning, and critical events.
Least restrictive form of event notification.
omconfig system events type=<componentname> severity=warning
Enables notification for warning and critical events.
Omits informational event notification, for example, when a component returns to normal status.
omconfig system events type=<componentname> severity=critical
Enables notification for critical events only.
Restrictive form of event notification.
omconfig system events type=<componentname> severity=none
Disables event notification.
No event notification.
Index
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.
omconfig system webserver
Use the omconfig system webserver command to start or stop the Web server. Table 6-23 shows the valid parameters for the command.
Table 6-23. Web Server Configuration Parameters
name=value pair
Description
action=start
Starts the Web server.
action=stop
Stops the Web server.
action=restart
Restarts the Web server.
omconfig system recovery
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 6-24 shows the valid parameters for the command.
NOTE: Upper and lower limits for the timer are dependent on your system model and configuration.
Table 6-24. Recovery Parameters
name=value pair
Description
action=none
Takes no action when the operating system is hung or has crashed.
action=reboot
Shuts down the operating system and initiates system startup, performing BIOS checks and reloading the operating system.
action=poweroff
Turns off electrical power to the system.
action=powercycle
Turns off electrical power to the system, pauses, turns the power on, and reboots the system. Power cycling is useful when you want to reinitialize system components such as hard drives.
timer=<n>
Number of seconds that must pass before a system is considered to have a hung operating system (from 20 seconds to 480 seconds).
Example Recovery Commands
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
omconfig system shutdown
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 6-25 shows the valid parameters for the command.
Table 6-25. Shutdown Parameters
name=value pair
Description
action=reboot
Shuts down the operating system and initiates system startup, performing BIOS checks and reloading the operating system.
action=poweroff
Turns the electrical power to the system off.
action=powercycle
Turns the electrical power to the system off, pauses, turns the power on, and reboots the system. Power cycling is useful when you want to reinitialize system components such as hard drives.
osfirst=true | false
true: Closes the file system and exits the operating system before shutting down the system.
false: Does not close the file system or shut down the operating system before shutting down the system.
Example Shutdown Commands
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
omconfig system thrmshutdown
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 6-26 shows the valid parameters for the command.
Table 6-26. Thermal Shutdown Parameters
name=value pair
Description
severity=disabled | warning | failure
disabled: Disable thermal shutdown. An administrator must intervene.
warning: Perform a shutdown when a temperature warning event is detected. A warning event occurs when any temperature probe inside a chassis reads a temperature (in degrees Celsius) which exceeds the maximum temperature warning threshold.
failure: Perform a shutdown when a temperature failure event is detected.
Example Thermal Shutdown Commands
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:
Offers subject to change, not combinable with all other offers. Taxes, shipping, handling and other fees apply. U.S. Dell Home and Home Office new purchases only. Free shipping and handling offer available in Continental (except Alaska) U.S. only. Free shipping offer does not include time to build/test system. Dell reserves the right to cancel orders arising from pricing or other errors.