omconfig: Managing Components Using the Instrumentation Service

Dell™ OpenManage™ Server Administrator Version 5.3
Command Line Interface User's Guide

omconfig Command Summary

Help With the omconfig Command

omconfig about

omconfig chassis/omconfig mainsystem

omconfig preferences

omconfig system/omconfig servermodule

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 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, fans, voltage probes, and temperature probes.

For information on using the omconfig system command to view and manage cost of ownership information (assetinfo), see "omconfig system or servermodule 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 or omreport mainsystem temp 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."

Table 4-1. System Availability for the omconfig Command

Command Level 1	Command Level 2	Applicable to
omconfig	servermodule	Modular system
	mainsystem	Modular system
	system	Non-modular system
	chassis	Non-modular system

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 not installed on your system, Server Administrator issues a message that the component or feature is not found on the system.

Table 4-2 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 4-2. omconfig Command Level 1, Level 2, and Level 3

Command Level 1	Command Level 2	Command Level 3	User Privilege Required	Use
omconfig
	about		U, P, A	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 Microsoft Active Directory^® service.
		snmp	A	Sets the SNMP root password. Configures SNMP Set Operations.
		useraccess	A	Determines whether users below the administrator level are allowed to use Server Administrator or not.
	system/ servermodule
		alertaction	P, A	Determines in advance the actions 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 alert 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 command log.
		esmlog	P, A	Allows the administrator to clear the ESM 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/ mainsystem
		biossetup	A	Configures the behavior of specific system components controlled by the BIOS.
		bmc	A	Configures remote access information. NOTE: This command is phased-out in this releases. It is replaced by the remoteaccess command.
		fans	P, A	Configures fan probe warning thresholds by default or by value. NOTE: You cannot change threshold values on embedded server management (ESM3) and Dell™ PowerEdge™ x8xx 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, 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.
		pwrmonitoring	P, A	Configures power consumption information and thresholds.
		remoteaccess	A	Configures remote access information.
		temps	P, A	Sets warning threshold values by default or value. NOTE: You cannot change threshold values on ESM3 and PowerEdge x8xx systems.
		volts	P, A	Sets warning threshold values by default or value. NOTE: You cannot change threshold values on ESM3 and PowerEdge x8xx systems.
	storage			See "Using the Storage Management Service."

Help With the omconfig Command

Use the omconfig -? command to get a list of the available commands for omconfig.

Use omconfig <command level 2> -? to get help on the about, chassis, preferences, and system's level 2 commands. 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 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 command line interface (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 the CLI help output.

To make a file that contains all 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^®, Red Hat^® Enterprise Linux^®, or SUSE^® Linux Enterprise Server 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 an example output of the omconfig about command:

Product name

: Dell OpenManage Server Administrator

Version

: 5.x.x

Copyright

: Copyright (C) Dell Inc. 1995-2006. All rights reserved.

Company

: Dell Inc.

For 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

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 5.x.x

omconfig chassis/omconfig mainsystem

Use the omconfig chassis or omconfig mainsystem commands to default or to set values for 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 -? or omconfig mainsystem -? command to view a list of all omconfig chassis/omconfig mainsystem commands.

omconfig chassis biossetup/omconfig mainsystem biossetup

Use the omconfig chassis biossetup or omconfig mainsystem 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: Reboot your system for the BIOS setup options take effect.

NOTE: Not all BIOS setup options are available on every system.

Table 4-3 shows the name=value pairs you can use with this command.

Table 4-3. BIOS Setup Settings

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: Enables the bezel removal intrusion check during system boot. disable: Disables the bezel removal intrusion check during system boot.
attribute=bootsequence	setting=diskettefirst \| hdonly \| devicelist \|cdromfirst	Instructs the BIOS which device is used to boot the system, and the order in which the boot routine is to check each device.
attribute=conredirect	setting=enable \| disable	enable: Redirects the BIOS screen over Serial Port 1. Keyboard and text output are redirected over Serial Port 2. disable: Turns off the BIOS console redirection.
attribute=crab	setting=enable \| disable	enable: Enables BIOS console redirection after system reboot. disable: Disables BIOS console redirection. NOTE: The command crab is valid for Dell PowerEdge x9xx systems only.
attribute=cpuht	setting=enable \| disable	enable: Enables logical processor hyperthreading. disable: Disables logical processor hyperthreading.
attribute=cpuvt	setting=enable \| disable	enable: Enables virtualization. disable: Disables virtualization.
attribute=dbs	setting=enable \| disable	enable: Enables Demand Based Power Management (DBS) on the system. disable: Disables DBS on the system.
attribute=diskette	setting=off \| auto \| writeprotect	off: Disables the diskette drive. auto: Auto-enables the diskette drive. writeprotect: Do not allow writes. Make the diskette drive read-only.
attribute=dualnic	setting=off \| onpxeboth \| onpxenone \| onpxenic1 \| onpxenic2	off: Disables the network interface controller's (NIC). onpxeboth: Enables both the NICs are PXE. onpxenone: PXE is not enabled on either of the NICs. onpxenic1: Enables PXE on NIC 1. onpxenic2: Enables PXE on NIC 2.
attribute=embhypvisor	setting=enabled \| disabled	enabled: Enables embedded hypervisor. disabled: Disables embedded hypervisor.
attribute=extserial	setting=com1 \| com2 \| rad	com1: Maps external serial connector to COM 1. com2: Maps external serial connector to COM 2. rad: Maps external serial connector to remote access device.
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: Enables this device. off: Disables this device. force=true: Verification of setting change.
attribute=idepridrv	setting=off \| auto	off: Disables the device. auto: Detects and enables the device automatically.
attribute=intrusion	setting=enable \| disable	enable: Enables the intrusion check during system boot. If the system also has bezel intrusion checking, then the intrusion option checks for removal of the bezel of the system. disable: Disables the intrusion check during system boot.
attribute=intusb	setting=enabled \| disabled	enabled: Enables the internal USB drive. disabled: Disables the internal USB drive.
attribute=mouse	setting=on \| off	on: Enables the mouse. off: Disables the mouse.
attribute=nic1	setting=enabled \| enabledwithpxe \| disabled \| enabledonly \| enablednonepxe \| enabledwithiscsi	enabled: Enables the first NIC during system boot. enabledwithpxe: Enables the first NIC during system boot (with PXE on if the system has PXE) disabled: Disables the first NIC during system boot. enabledonly: Enables the first NIC during system boot (with PXE off if the system has PXE). enablednonepxe: Enables the first NIC during system boot (with PXE off if the system has PXE). enabledwithiscsi: Enables the first NIC during system boot (with iSCSI on if the system has iSCSI).
attribute=nic2	setting=enabled \| enabledwithpxe \| disabled \| enabledonly \| enablednonepxe \| enabledwithiscsi	enabled: Enables the second NIC during system boot. enabledwithpxe: Enables the second NIC during system boot (with PXE on if the system has PXE) disabled: Disables the second NIC during system boot. enabledonly: Enables the second NIC during system boot (with PXE off if the system has PXE). enablednonepxe: Enables the second NIC during system boot (with PXE off if the system has PXE). enabledwithiscsi: Enables the second NIC during system boot (with iSCSI on if the system has iSCSI).
attribute=nic3	setting=enabled \| enabledwithpxe \| disabled \| enabledonly \| enablednonepxe \| enabledwithiscsi	enabled: Enables the third NIC during system boot. enabledwithpxe: Enables the third NIC during system boot (with PXE on if the system has PXE) disabled: Disables the third NIC during system boot. enabledonly: Enables the third NIC during system boot (with PXE off if the system has PXE). enablednonepxe: Enables the third NIC during system boot (with PXE off if the system has PXE). enabledwithiscsi: Enables the third NIC during system boot (with iSCSI on if the system has iSCSI).
attribute=nic4	setting=enabled \| enabledwithpxe \| disabled \| enabledonly \| enablednonepxe \| enabledwithiscsi	enabled: Enables the fourth NIC during system boot. enabledwithpxe: Enables the fourth NIC during system boot (with PXE on if the system has PXE) disabled: Disables the fourth NIC during system boot. enabledonly: Enables the fourth NIC during system boot (with PXE off if the system has PXE). enablednonepxe: Enables the fourth NIC during system boot (with PXE off if the system has PXE). enabledwithiscsi: Enables the fourth NIC during system boot (with iSCSI on if the system has iSCSI).
attribute=numlock	setting=on \| off	on: Uses the keypad as number keys. off: Uses the keypad as arrow keys.
attribute=ppaddress	setting=off \| lpt1 \| lpt2 \| lpt3	off: Disables the parallel port address. lpt1: Locates the device on LPT1. lpt2: Locates the device onLPT2. lpt3: Locates the device on LPT3.
attribute=ppmode	setting=at \| ps2 \| ecp \| epp	at: Sets the parallel port mode to type AT. ps2: Sets the parallel port mode to type PS/2. ecp: Sets the parallel port mode to type ECP (extended capabilities port). epp: Sets 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: Enables this device. off: Disables 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: Disables 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 the SATA controller. ata: Sets the onboard SATA controller to ATA mode. raid: Sets the onboard SATA controller to RAID mode.
attribute=sataport (0...7) or (A...H)	setting=off \| auto	off: Disables the SATA port. auto: Automatically enable the SATA port.
attribute=secondaryscsi	setting=on \| off	on: Enables this device. off: Disables this device.
attribute=serialcom	setting=off \| on \|com1 \|com2	off: Disables serial communication setting. on: Enables serial communication setting without console redirection. com1: Enables serial communication setting with console redirection via COM 1. com2: Enables serial communication setting with console redirection via COM 2.
attribute=serialport1	setting=off \| auto \| com1 \| com3 \| bmcserial \| bmcnic \| rac \| com1bmc	off: Disables serial port 1. auto: Maps serial port 1 to a COM port. com1: Maps serial port 1 to COM port 1. com3: Maps serial port 1 to COM port 3. bmcserial: Maps serial port 1 to BMC Serial. bmcnic: Maps serial port 1 to the Baseboard Management Controller (BMC) NIC. rac: Maps serial port 1 to the Remote Access Controller (RAC). com1bmc: Maps serial port 1 to COM port 1 bmc. NOTE: This command is valid on PowerEdge 1850, 2800, and 2850 systems only.
attribute=serialport2	setting=off \| auto \| com2 \| com4	off: Disables serial port 2. auto: Maps serial port 2 to a COM port. com2: Maps serial port 2 to COM port 2. com4: Maps serial port 2 to COM port 4.
attribute=speaker	setting=on \| off	on: Enables the speaker. off: Disables the speaker.
attribute=uausb	setting=on \| backonly \| off	on: Enables the user-accessible USB port(s) backonly: Enables only the user accessible USB port(s) located at the back of the system. off: Disables the user-accessible USB port(s).
attribute=usb	setting=enabled \| disabled	enabled: Enables the USB port(s). disabled: Disables the USB port(s). NOTE: Depending on your system's hardware, only one of the two attributes usb and usbb is available for configuring the USB port(s).
attribute=usbb	setting=enabled \| enabledwithbios\| disabled	enabled: Enables the USB port(s) during system boot, without BIOS support. enabledwithbios: Enables the USB port(s) during the system boot, with BIOS support. disabled: Disables the USB port(s) during system boot. NOTE: Depending on your system's hardware, only one of the two attributes usb and usbb is available for configuring the USB port(s).

omconfig chassis bmc/omconfig mainsystem bmc

NOTE: This command is phased-out in this release. It is replaced by the omconfig chassis remoteaccess/omconfig mainsystem remoteaccess command.

omconfig chassis currents/omconfig mainsystem currents

NOTE: This command is no longer available through Server Administrator.

omconfig chassis fans/omconfig mainsystem fans

Use the omconfig chassis fans or omconfig mainsystem 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 4-4 shows the valid parameters for setting fan warning thresholds:

Table 4-4. omconfig chassis fans/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, ESM4, and BMC 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
or
omconfig mainsystem 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.

Specifying 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:

omconfig chassis fans index=0 minwarnthresh=4580
or
omconfig mainsystem fans index=0 minwarnthresh=4580

omconfig chassis fans index=0 minwarnthresh=4580 maxwarnthresh=9160
or
omconfig mainsystem fans index=0 minwarnthresh=4580 maxwarnthresh=9160

When you issue the command and the system sets the values you specify, the following message appears:

Fan probe warning threshold(s) set successfully.

NOTE: Minimum and maximum warning thresholds for the fan probe cannot be set on PowerEdge x8xx and x9xx systems.

omconfig chassis fancontrol/omconfig mainsystem fancontrol

Use the omconfig chassis fancontrol or omconfig mainsystem fancontrol command to set the fan speed. You can optimize speed for cooling or for quiet operation. Table 4-5 shows the valid parameters for the command.

Table 4-5. omconfig chassis fancontrol/omconfig mainsystem fancontrol

name=value pair	Description
speed=quiet	Sets fan speed for quiet operation.
speed=maxcool	Sets fan speed for maximum cooling.

omconfig chassis frontpanel/omconfig mainsystem frontpanel

Use the omconfig chassis frontpanel or omconfig mainsystem frontpanel command to configure the Power button and the Nonmasking Interrupt (NMI) button and to specify and configure the LCD line number.

NOTE: The Power and NMI buttons can be configured only if present on the system.

Table 4-6 shows the valid parameters for the command.

Table 4-6. omconfig chassis frontpanel/omconfig mainsystem frontpanel

name=value pair 1	name=value pair 2	Description
lcdindex=<index>	NA	Specifies the LCD line number.
config=none \| default \| custom	NA	none: Sets the LCD text to none. default: Sets the LCD text to default. custom: Sets the LCD text to custom.
text=<custom text>	NA	Sets the custom text for LCD when config=custom.
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/omconfig mainsystem info

Use the omconfig chassis info or omconfig mainsystem 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 4-7 shows the valid parameters for the command.

Table 4-7. omconfig chassis info/omconfig mainsystem 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
or
omconfig mainsystem info index=0 tag=buildsys

Index 0 always defaults to the main system chassis. The following command omits index=n, but accomplishes the same thing:

omconfig chassis info tag=buildsys
or
omconfig mainsystem 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
or
omconfig mainsystem 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/omconfig mainsystem leds

Use the omconfig chassis leds or omconfig mainsystem leds command to specify when to flash a chassis fault LED or chassis identification LED. This command also allows you to clear the LED for the system's hard drive. Table 4-8 shows the valid parameters for the command.

Table 4-8. omconfig chassis leds/omconfig mainsystem 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/omconfig mainsystem memorymode

Use the omconfig chassis memorymode or omconfig mainsystem 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 that the system is currently using. The omconfig chassis memorymode or omconfig mainsystem 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. To enable redundancy, choose among spare, mirror, and RAID.

Spare 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.

Mirror 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.

RAID mode provides an extra level of memory checking and error recovery at the expense of some memory capacity.

Table 4-9 shows the valid parameters for the command.

Table 4-9. omconfig chassis memorymode/omconfig mainsystem 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 \| mirror \| 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. Mirror switches the systems to a mirrored copy of the memory if the failing module has an uncorrectable memory event. In the mirror mode, the operating system does not switch back to the original module until the system reboots. RAID-5 is a method of system memory configuration. This is logically similar to the RAID-5 mode used in hard drive storage systems. This memory mode provides 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.

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 | mirror | 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.
Mirror switches the systems to a mirrored copy of the memory if the failing module has an uncorrectable memory event. In the mirror mode, the operating system does not switch back to the original module until the system reboots.
RAID-5 is a method of system memory configuration. This is logically similar to the RAID-5 mode used in hard drive storage systems. This memory mode provides 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 pwrmonitoring/omconfig mainsystem pwrmonitoring

Use the omconfig chassis pwrmonitoring or omconfig mainsystem pwrmonitoring command to configure power consumption information.

Table 4-10. omconfig chassis pwrmonitoring/omconfig mainsystem pwrmonitoring

name=value pair 1	name=value pair 2	Description
index=<n>	NA	Number of the probe or probe index (must be specified).
config=probe	NA	Sets the threshold value for the power consumption probe.
warnthresh=settodefault	NA	Sets minimum and maximum warning thresholds values to default.
warnthresh=<n>	NA	Sets a value for the warning threshold.
config=resetreading	type=energy \| peakpower	energy: Resets the system energy reading. peakpower: Resets the system peak power.

NOTE: This command is applicable to selected Dell xx0x systems that supports PMBus only.

Default Warning Thresholds

NOTE: The capabilities for managing sensors vary by systems.

If you want to set both the upper and lower power consumption probe warning threshold values to the recommended default value, type:

omconfig chassis pwrmonitoring index=0 warnthresh=settodefault
or
omconfig mainsystem pwrmonitoring index=0 warnthresh=settodefault

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 Warning Thresholds

If you prefer to specify values for the power consumption 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 pwrmonitoring index=4 warnthresh=325
or
omconfig mainsystem pwrmonitoring index=4 warnthresh=325.

When you issue the command and the system sets the values you specify, the following message appears:

Power consumption probe warning threshold(s) set successfully.

omconfig chassis remoteaccess/omconfig mainsystem remoteaccess

NOTE: This command is applicable to PowerEdge x8xx and x9xx systems only.

Use the omconfig chassis remoteaccess or omconfig mainsystem remoteaccess command to configure:

Remote access on a local area network (LAN).
The serial port for BMC or RAC, whichever is installed.
The BMC or RAC on a serial over LAN connection.
Terminal settings for the serial port.
Advanced settings for a serial over LAN connection.
Information on a BMC or RAC user.

NOTE: You have to Enter the user ID to configure user information.

Type:

omconfig chassis remoteaccess
or
omconfig mainsystem remoteaccess

The output of the omconfig chassis remoteaccess or omconfig mainsystem remoteaccess command lists each of the available configurations. Table 4-11 shows the valid parameters:

Table 4-11. omconfig chassis remoteaccess/omconfig mainsystem
remoteaccess

name=value pair 1
config=

name=value pair 2

Description

config=advsol

characcuminterval=number

number: Sets the character accumulate interval in 5 millisecond intervals.

charsendthreshold=number

number: Sets the number of characters. BMC automatically sends a serial over LAN data packet that contains the 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.

encryptkey=text

confirmencryptkey=text

text: Text used for encryption and confirmation of encryption.

NOTE: The text option is supported only on PowerEdge x9xx systems.

gateway=Gateway

Gateway: Sets a gateway address if you have selected static as the IP address source for the BMC LAN interface.

enablenic=true | false

true: Enables DRAC NIC.

false: Disables DRAC NIC

NOTE: The enablenic option is supported on PowerEdge x9xx systems that have DRAC 5 installed.

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 your system.

nicselection=nic1 | teamednic1nic2 | dracnic

nic1: Enables NIC 1.

teamednic1nic2: Enables NIC teaming functionality.

dracnic: Enables DRAC NIC if DRAC 5 is installed.

NOTE: The nicselection option is supported only on PowerEdge x9xx systems.

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.

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.

vlanid=number

number: Virtual LAN identification in the range of 1 to 4094.

vlanpriority=number

number: Priority of virtual LAN identification in the range of 0 to 7.

config=serial

baudrate=9600 | 19200 | 38400 | 57600 | 115200

9600: Sets the connection speed to 9600 bits per second.

19200: Sets the connection speed to 19200 bits per second.

38400: Sets the volatile and non-volatile connection speed to 38400 bits per second.

57600: Sets the volatile and non-volatile connection speed to 57600 bits per second.

115200: Sets the volatile and non-volatile connection speed to 115200 bits per second.

NOTE: Baud rates of 9600 and 19200 are supported on PowerEdge 1800, 1850, 2800, and 2850 systems.
Baud rates of 19200, 38400, and 57600 are supported on PowerEdge x9xx systems.
Baud rate of 115200 is supported on certain systems that have a DRAC 5 installed.
Baud rate of 19200, 57600, and 115200 are supported on xx0x systems that have iDRAC installed.

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.

config=serial
(continued)

directbasic: Type of messaging used for IPMI messaging over a serial connection.

directterminal: Type of messaging that uses printable ASCII characters and allows a limited number of text commands over a serial connection.

directbasicterminal: Both basic and terminal mode messaging over a serial connection.

modembasic: Type of messaging used for IPMI messaging over a modem.

modemterminal: Type of messaging that uses printable ASCII characters and allows a limited number of text commands over a modem.

modembasicterminal: Both basic and terminal messaging over a modem.

NOTE: Not all commands may be supported on the system.

privilegelevel=administrator | operator | user

administrator: Sets the maximum privilege level that can be accepted on a serial connection, to Administrator.

operator: Sets the maximum privilege level that can be accepted on a serial connection, to Operator.

user: Sets the maximum privilege level that can be accepted on a serial connection, to User.

config=serialoverlan

enable=true | false

true: Enables serial over LAN for the BMC.

false: Disables serial over LAN for the BMC.

baudrate=9600 | 19200 | 38400 | 57600 | 115200

9600: Sets the volatile and nonvolatile connection speed to 9600 bits per second.

19200: Sets the volatile and non-volatile connection speed to 19200 bits per second.

38400: Sets the volatile and non-volatile connection speed to 38400 bits per second.

57600: Sets the volatile and non-volatile connection speed to 57600 bits per second.

115200: Sets the volatile and non-volatile connection speed to 115200 bits per second.

NOTE: Baud rates of 9600 and 19200 are supported on PowerEdge 1800, 1850, 2800, and 2850 systems.
Baud rates of 19200, and 57600 are supported on PowerEdge x9xx systems.
Baud rate of 115200 is supported on certain systems that have a DRAC 5 installed.
Baud rate of 19200, 57600, and 115200 are supported on xx0x systems that have iDRAC installed.

privilegelevel=administrator | operator | user

administrator: Sets the maximum privilege level that can be accepted on a serial over LAN channel, to Administrator.

operator: Sets the maximum privilege level that can be accepted on a serial over LAN channel, to Operator.

user: Sets the maximum privilege level that can be accepted on a serial over LAN channel, to User.

config=settodefault

Takes the default configuration settings.

config=terminalmode

deletecontrol=outputdel | outputbkspspbksp

outputdel: BMC outputs a <del> character when <bksp> or <del> is received.

outputbkspspbksp: BMC outputs a <bksp><sp><bksp> character when <bksp> or <del> is received.

config=terminalmode (continued)

echocontrol=enabled | disabled

enabled: Enables characters to be sent to the screen.

disabled: Disables characters to be sent to the screen.

handshakingcontrol=enabled | disabled

enabled: Directs the BMC to output a character sequence that indicates when its input buffer is ready to accept another command.

disabled: Does not direct the BMC to output a character sequence that indicates when its input buffer is ready to accept another command.

inputlinesequence=cr | null

cr: The console uses <CR> as a new line sequence.

null: The console uses <NULL> as a new line sequence.

lineediting=enabled | disabled

enabled: Enables line editing as a line is typed.

disabled: Disables line editing as a line is typed.

none: BMC does not use a termination sequence.

crlf: BMC uses <CR-LF> as a new line sequence when the BMC writes a new line to the console.

null: BMC uses <Null> as a new line sequence when the BMC writes a new line to the console.

cr: BMC uses <CR> as a new line sequence when the BMC writes a new line to the console.

lfcr: BMC uses <LF-CR> as a new line sequence when the BMC writes a new line to the console.

lf: BMC uses <LF> as a new line sequence when the BMC writes a new line to the console.

config=user

id=number enable=true | false

id=number: ID (in numeric format) of the user being configured.

enable=true: Enables user.

enable=false: Disables user.

id=number enableserialoverlan=true | false

id=number: ID (in numeric format) of the user being configured.

enableserialoverlan=true: Enables serial over LAN.

enableserialoverlan=false: Disables serial over LAN.

NOTE: The enableserialoverlan option is supported only on PowerEdge x9xx systems.

id=number name=text

number: ID (in numeric format) of the user being configured.

name=text: Name of the user.

id=number newpw=text

confirmnewpw=text

number: ID (in numeric format) of the user being configured.

newpw=text: New password of the user.

confirmnewpw=text: Confirm the new password.

id=number serialaccesslevel=administrator | operator | user | none

id=number: ID (in numeric format) of the user being configured.

serialaccesslevel=administrator: User with an ID has access privileges of an Administrator for the serial port channel.

serialaccesslevel=operator: User with an ID has access privileges of an Operator for the serial port channel.

serialaccesslevel=user: User with an ID has access privileges of a User for the serial port channel.

serialaccesslevel=none: User with an ID does not have access privileges for the serial port channel.

config=user
(continued)

id=number lanaccesslevel=administrator | operator | user| none

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.

id=user id
dracusergroup=admin | poweruser | custom | none

id=user id: User ID of the user being configured.

dracusergroup=admin: Enables the Administrator user privileges.

dracusergroup=poweruser: Enables the Power User privileges.

dracusergroup=custom: Enables the Custom User privileges.

NOTE: See Table 4-12 for more information on the name=value pair. dracusergroup=custom.

dracusergroup=none: Does not enable user privileges.

id=user id
extimpiusergroup=admin | poweruser | custom | none

NOTE: extimpiusergroup user group is available only on Dell xx0x modular systems.

id=user id: User ID of the user being configured.

extimpiusergroup=admin: Enables the Administrator user privileges.

extimpiusergroup=poweruser: Enables the Power User privileges.

extimpiusergroup=custom: Enables the Custom User privileges.

NOTE: See Table 4-13 for more information on the name=value pair. extimpiusergroup=custom.

extimpiusergroup=none: Does not enable user privileges.

Table 4-12. omconfig chassis remoteaccess config=user id=<user id>
dracusergroup=custom/omconfig mainsystem remoteaccess
config=user id=<user id> dracusergroup=custom

name=value pair 1	name=value pair 2	name=value pair 3	Description
config=user (continued)	id=user id dracusergroup=custom	logindrac= true \| false configuredrac= true \| false configure users= true \| false clearlogs= true \| false executeservercommands= true \| false accessconsoleredir= true \| false accessvirtualmedia= true \| false testalerts= true \| false	true/false: Enables/disables logging into DRAC. true/false: Enables/disables configuration of DRAC. true/false: Enables/disables configuration of users. true/false: Enables/disables log clearance. true/false: Enables/disables execution of server commands. true/false: Enables/disables access to console redirection. true/false: Enables/disables access to virtual media. true/false: Enables/disables test alerts.

name=value pair 1

name=value pair 2

name=value pair 3

Description

config=user
(continued)

id=user id
dracusergroup=custom

logindrac= true | false

configuredrac= true | false

configure users= true | false

clearlogs= true | false

executeservercommands= true | false

accessconsoleredir= true | false

accessvirtualmedia= true | false

testalerts= true | false

true/false: Enables/disables logging into DRAC.

true/false: Enables/disables configuration of DRAC.

true/false: Enables/disables configuration of users.

true/false: Enables/disables log clearance.

true/false: Enables/disables execution of server commands.

true/false: Enables/disables access to console redirection.

true/false: Enables/disables access to virtual media.

true/false: Enables/disables test alerts.

Table 4-13. omconfig chassis remoteaccess config=user id=<user id> extimpiusergroup=custom/omconfig mainsystem remoteaccess config=user id=<user id> extimpiusergroup=custom

name=value pair 1

name=value pair 2

name=value pair 3

Description

config=user
(continued)

id=user id
extimpiusergroup=custom

NOTE: extimpiusergroup user group is available only on Dell xx0x modular systems.

loginidrac= true | false

configureidrac= true | false

true/false: Enables/disables logging into iDRAC.

true/false: Enables/disables configuration of iDRAC.

omconfig chassis temps/omconfig mainsystem temps

Use the omconfig chassis temps or omconfig mainsystem 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 threshold values. Your system's manufacturer sets the minimum and maximum failure threshold values.

NOTE: Threshold values that you can set vary from one system configuration to another.

Valid Parameters for Temperature Warning Thresholds

Table 4-14 shows the valid parameters for setting temperature warning thresholds:

Table 4-14. omconfig chassis temps/omconfig mainsystem temps

name=value pair	Description
index=<n>	Number of the probe or probe index (must be specified).
warnthresh=default	Sets the minimum and maximum warning threshold values to default.
minwarnthresh=<n>	Sets the minimum warning threshold values (1 decimal place).
maxwarnthresh=<n>	Sets the maximum warning threshold values (1 decimal place).

Setting Minimum and Maximum Warning Threshold 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
or
omconfig mainsystem temps index=0 warnthresh=default

You cannot default one value and set another. In other words, if you set the minimum warning threshold value to the default value, you are also selecting the default value for the maximum warning threshold value.

NOTE: The capabilities for managing sensors vary by systems.

Specify a Value for Minimum and Maximum Warning Thresholds

If you want 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
or
omconfig mainsystem 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.

NOTE: In PowerEdge x8xx and x9xx systems, warning threshold for the temperature probe can be set only for the ambient temperature.

omconfig chassis volts/omconfig mainsystem volts

Use the omconfig chassis volts or omconfig mainsystem 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 threshold values. Your system's manufacturer sets the minimum and maximum values for the failure thresholds.

Valid Parameters for Voltage Warning Thresholds

Table 4-15 shows the valid parameters for setting voltage warning threshold values.

NOTE: Threshold values that you can set vary from one system configuration to another.

Table 4-15. omconfig chassis volts/omconfig mainsystem volts

name=value pair	Description
index=<n>	Probe index (must be specified).
warnthresh=default	Sets minimum and maximum warning threshold values to default.
minwarnthresh=<n>	Sets minimum warning threshold value(3 decimal places).
maxwarnthresh=<n>	sets maximum warning threshold value (3 decimal places).

Default Minimum and Maximum Warning Threshold Values

If you want to set both the upper and lower voltage warning threshold values to the recommended default value, type:

omconfig chassis volts index=2 warnthresh=default
or
omconfig mainsystem volts 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.

NOTE: Systems that contain ESM3 capabilities do not allow you to set warning threshold values to default values.

Specify a Value for Minimum and Maximum Warning Thresholds

If you want 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 being configured is probe 0:

omconfig chassis volts index=0 minwarnthresh=1.900 maxwarnthresh=2.250
or
omconfig mainsystem 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.

NOTE: Minimum and maximum warning threshold values for the voltage cannot be set on PowerEdge x8xx systems.

omconfig preferences

Use the omconfig preferences command to set system preferences. Use the command line, to set the SNMP root password and specify the user levels able to access Server Administrator. You can also configure the Active Directory service and SNMP set operations.

omconfig preferences cdvformat

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 <computername>-<productname> default value is used. <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, the product name is "omsa".

Therefore, for a computer named "myOmsa" running Server Administrator, the default name would be "myOmsa–omsa". This is the name of Server Administrator defined in Active Directory by using the snap–in 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 4-16 shows the valid parameters for the command.

Table 4-16. Active Directory Service Configuration Parameters

name=value pair	Description
prodname=<text>	Specifies 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>	Specifies 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.

name=value pair

Description

prodname=<text>

Specifies 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>

Specifies 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.

Using the omconfig preferences snmp command, you can also configure SNMP set operations.

NOTICE: Interactive mode is the more secure method of setting the SNMP root password. In non-interactive mode, the values you enter for the newpw and confirmnewpw options appear on your system's monitor when you type them. In the 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 4-17 shows the valid parameters for the command.

Table 4-17. 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 the parameters in the initial command line. For example:

omconfig preferences snmp setting=rootpw oldpw=openmanage newpw=serveradmin confirmnewpw=serveradmin

name=value pair

Description

setting=snmpset

Required

enable=true

Allows SNMP set operations

enable=false

Disallows SNMP set operations

name=value pair	Description
setting=snmpset	Required
enable=true	Allows SNMP set operations
enable=false	Disallows SNMP set operations

For example, to disallow SNMP set operations use the following command:

omconfig preferences snmp setting=snmpset enable=false

NOTE: After executing the command to enable or disable SNMP set operations, restart services for the change to take effect. On systems running supported Microsoft Windows operating systems, restart the Windows SNMP Service. On systems running supported Red Hat Enterprise Linux and SUSE Linux Enterprise Server operating systems, restart Server Administrator services by running the srvadmin-services.sh restart command.

omconfig preferences useraccess

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 4-19 shows the valid parameters for the command.

Table 4-19. 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.

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/omconfig servermodule

Use the omconfig system or omconfig servermodule 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/omconfig servermodule alertaction

You can use the omconfig system alertaction or omconfig servermodule 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 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 users are notified of this event. You can also configure alert actions for temperature, voltage, and probe readings that fall within the warning or failure range.

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 to take for this event. For example, in the command:

omconfig system alertaction event=powersupply broadcast=true
or
omconfig servermodule 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 4-20 shows the alert actions for each component that allows you to configure an alert action.

Table 4-20. Alert Actions You Can Set for Warning and Failure Events

Alert Action Setting

Description

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 who have an active terminal (or Remote Desktop) session (Windows) or to operators that have an active shell on the local system (Linux).

false: Disables alert broadcasts.

clearall=true

Clears all actions for this event.

execappath=<string>

Sets the fully qualified path and file name of the application you want to execute in case of an event for the component described in this window.

NOTE: On Linux systems, user/user groups upgraded to administrator/administrator groups cannot configure this alert action setting.

execapp=false

Disables the executable application.

Components and Events for Which You Can Set Alert Actions

Table 4-21 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 4-21. Events for Which You Can Set Alert Actions

Event Name	Description
event=batterywarn	Sets actions when a battery probe detects a warning value.
event=batteryfail	Sets actions when a battery 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=systempowerwarn	Sets actions when a power consumption probe detects a warning value.
event=systempowerfail	Sets actions when a power consumption 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 that Server Administrator performs on the next system startup after a watchdog Automatic System Recovery (ASR) is performed for a hung operating system.
event=storagesyswarn	Sets actions when a storage system detects a warning value.
event=storagesysfail	Sets actions when a storage system detects a failure value.
event=storagectrlwarn	Sets actions when a storage controller detects a warning value.
event=storagectrlfail	Sets actions when a storage controller detects a failure value.
event=pdiskwarn	Sets actions when a physical disk detects a warning value.
event=pdiskfail	Sets actions when a physical disk detects a failure value.
event=vdiskwarn	Sets actions when a virtual disk detects a warning value.
event=vdiskfail	Sets actions when a virtual disk detects a failure value.
event=enclosurewarn	Sets actions when an enclosure detects a warning value.
event=enclosurefail	Sets actions when an enclosure detects a failure value.
event=storagectrlbatterywarn	Sets actions when a storage controller battery detects a warning value.
event=storagectrlbatteryfail	Sets actions when a storage controller battery detects a failure value.

NOTE: storagectrlbatterywarn and storagectrlbatteryfail events are not available on modular systems.

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 console alert if a current probe detects a warning event, type:

omconfig system alertaction event=currentwarn alert=false
or
omconfig servermodule alertaction event=currentwarn alert=false

To enable broadcast messages if a current probe detects a failure event, type:

omconfig system alertaction event=currentfail broadcast=true
or
omconfig servermodule alertaction event=currentfail broadcast=true

Example Fan Probe Actions

To generate alerts when a fan probe detects a failure value, type:

omconfig system alertaction event=fanfail alert=true
or
omconfig servermodule 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
or
omconfig servermodule 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 or omconfig servermodule 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
or
omconfig servermodule 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
or
omconfig servermodule cmdlog action=clear

To clear the contents of the ESM log, type:

omconfig system esmlog action=clear
or
omconfig servermodule esmlog action=clear

omconfig system pedestinations/omconfig servermodule pedestinations

Use the omconfig system pedestinations or omconfig servermodule pedestinations command to set IP addresses for alert destinations.

Table 4-22 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 only community string as a parameter.

Table 4-22. omconfig system pedestinations/omconfig servermodule 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/omconfig servermodule platformevents

Use the omconfig system platformevents or omconfig servermodule 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" or "power reduction", 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 4-23 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 4-23. Parameters for Alert Action Command

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 off the electrical power to the system, pauses, turns the power on, and reboots the system.

action=poweroff

Turns off the electrical power to the system.

action=powerreduction

Reduces the processor speed until the power consumption comes down and reaches below the warning threshold. If the system power consumption stays below the warning threshold, increases the processor speed

NOTE: This action is applicable only to non–modular systems.

action=reboot

Forces the operating system to shut down and initiates system startup, performs BIOS checks, and reloads the operating system.

Table 4-24 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.

Table 4-24. omconfig system platformevents

Event Name	Description
alertsenable=true \| false	true: Enables generation of platform event filter alerts. false: Disables generation of platform event filter alerts. 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=batterywarn	Sets action or enables/disables alert generation when a battery device detects that the battery is pending a failure condition.
event=batteryfail	Sets action or enables/disables alert generation when a battery device detects that the battery has failed.
event=discretevolt	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 is 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=powerabsent	Sets action or enables/disables alert generation when a processor probe detects that the power supply is absent.
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=processorabsent	Sets action or enables/disables alert generation when a processor probe detects that the processor is absent.
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=systempowerwarn	Sets actions when a power consumption probe detects a warning value.
event=systempowerfail	Sets actions when a power consumption probe detects a failure value.
event=powerreduction	Sets actions when a system is set to power reduction mode.
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/omconfig servermodule events

Use the omconfig system events or omconfig servermodule events command to enable and disable SNMP traps for the 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

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
or
omconfig servermodule events source=snmptraps

Type

Type refers to the name of the component(s) involved in the event. Table 4-25 shows the valid parameters for system event types.

Table 4-25. System Event Type Parameters

name=value pair	Description
type=accords	Configures events for AC power cords.
type=battery	Configures events for battery.
type=all	Configures events for all device types.
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=systempower	Configures events for system power.
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 specify whether you want to be notified for event severity according to the number of the component by using the index=<n> parameter. Table 4-26 shows the valid severity parameters.

Table 4-26. System Event Severity Parameters

Command	Result	Description
omconfig system events type=<component name> severity=info or omconfig servermodule events type=<component name> severity=info	Enables notification for informational, warning, and critical events.	Least restrictive form of event notification.
omconfig system events type=<component name> severity=warning or omconfig servermodule events type=<component name> 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=<component name> severity=critical or omconfig servermodule events type=<component name> severity=critical	Enables notification for critical events only.	Restrictive form of event notification.
omconfig system events type=<component name> severity=none or omconfig servermodule events type=<component name> 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. For example, when a system contains more than one fan, 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
or
omconfig servermodule events type=fan index=0 severity=critical

As a result of the example command, Server Administrator sends an SNMP trap only when the first fan in the system chassis (index 0) has reached critical fan RPMs.

omconfig system webserver/omconfig servermodule webserver

Use the omconfig system webserver or omconfig servermodule webserver command to start or stop the Web server. Table 4-27 shows the valid parameters for the command.

Table 4-27. 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/omconfig servermodule recovery

Use the omconfig system recovery or omconfig servermodule recovery command to set the action 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 4-28 shows the valid parameters for the command.

NOTE: Upper and lower limits for the timer are dependent on your system model and configuration.

Table 4-28. 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 re-initialize system components such as hard drives.
timer=<n>	Number of seconds that must pass before the operating system in a system is considered 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
or
omconfig servermodule 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
or
omconfig servermodule recovery timer=120

omconfig system shutdown/omconfig servermodule shutdown

Use the omconfig system shutdown or omconfig servermodule shutdown command to determine the way in which 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, use the osfirst=false parameter. Table 4-29 shows the valid parameters for the command.

Table 4-29. 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 off the electrical power to the system.
action=powercycle	Turns off the electrical power to the system, pauses, turns the power on, and reboots the system. Power cycling is useful when you want to re-initialize 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
or
omconfig servermodule shutdown action=reboot

To bypass operating system shutdown before the system is powered off, type:

omconfig system shutdown action=reboot osfirst=false
or
omconfig servermodule shutdown action=reboot osfirst=false

omconfig system thrmshutdown/omconfig servermodule thrmshutdown

Use the omconfig system thrmshutdown or omconfig servermodule 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 4-30 shows the valid parameters for the command.

Table 4-30. 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) that exceeds the maximum temperature warning threshold value.

failure: Perform a shutdown when a temperature failure event is detected.

A failure event occurs when any temperature probe inside a chassis reads a temperature (in degrees Celsius) that exceeds the maximum temperature failure threshold value.

Example Thermal Shutdown Commands

To trigger a thermal shutdown when a temperature probe detects a failure event, type:

omconfig system thrmshutdown severity=failure
or
omconfig servermodule thrmshutdown severity=failure

To disable thermal shutdown so that an administrator has to initiate an omconfig system shutdown, type:

omconfig system thrmshutdown severity=disabled
or
omconfig servermodule thrmshutdown severity=disabled

Back to Contents Page

Product name	: Dell OpenManage Server Administrator
Version	: 5.x.x
Copyright	: Copyright (C) Dell Inc. 1995-2006. All rights reserved.
Company	: Dell Inc.

Contains:	Instrumentation Service 5.x.x
	Storage Management Service 3.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 5.x.x