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.
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.
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.
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'slevel 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.
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 setupoptions 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.
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.
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:
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:
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.
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.
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.
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.
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.
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:
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 remoteaccessor omconfig mainsystem remoteaccess command lists each of the available configurations. Table 4-11 shows the valid parameters:
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.
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.
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.
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:
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 "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 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 Loginoptionon 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:
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.
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.