Dell OpenManage Server Administrator Version 6.1 User Manual
Dell™ OpenManage™
Server Administrator Version 6.1
Command Line Interface
User's Guide
Notes and Cautions
NOTE: A NOTE indicates important information that helps you make better use of
your computer.
CAUTION: A CAUTION indicates potential damage to hardware or loss of data
if instructions are not followed.
____________________
Information in this document is subject to change without notice.
© 2009 Dell Inc. All rights reserved.
Reproduction of these materials in any manner whatsoever without the written permission of Dell Inc.
is strictly forbidden.
Trademarks used in this text: Dell, the DELL logo, PowerEdge, and OpenManage are trademarks of
Dell Inc.; Microsoft, Windows, Active Directory, Hyper-V, MS-DOS and Windows Server are either
trademarks or registered trademarks of Microsoft Corporation in the United States and/or other
countries; SUSE is a registered trademark of Novell, Inc. in the United States and other countries;
Red Hat and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the United States
and other countries; Intel, Pentium, and Itanium are registered trademarks and Intel386 is a trademark
of Intel Corporation in the United States and other countries; AMD, AMD Opteron, AMD-V, and AMD
Pow er No w! are trademarks of Advanced Micro Devices, Inc.; UNIX is a registered trademark of The
Open Group in the United States and other countries; OS/2 is a registered trademark of
International Business Machines Corporation; Rambus is a registered trademark of Rambus, Inc.
Other trademarks and trade names may be used in this document to refer to either the entities claiming
the marks and names or their products. Dell Inc. disclaims any proprietary interest in trademarks and
trade names other than its own.
March 2009
Contents
1 Introduction . . . . . . . . . . . . . . . . . . . . . . . 15
What's New for Version 6.1 . . . . . . . . . . . . . . . 15
Using CLI Commands from Windows
Command Prompts
. . . . . . . . . . . . . . . . . . . 17
Primary CLI Commands
CLI Error Checking and Error Messages
Success Messages
Failure Messages
Scripting and Comparing With the CLI
Command Syntax Overview
. . . . . . . . . . . . . . . . . 17
. . . . . . . . 19
. . . . . . . . . . . . . . . . 19
. . . . . . . . . . . . . . . . . 19
. . . . . . . . . 20
. . . . . . . . . . . . . . . 21
2 Using the omhelp Command . . . . . . . . . . 23
Example Help Commands . . . . . . . . . . . . . . . . 23
3 omreport: Viewing System Status
Using the Instrumentation Service
Conventions for Parameter Tables . . . . . . . . . 28
Command Summary of the omreport Command
Help With the omreport Command
omreport modularenclosure
. . . . . . . . . . . 35
. . . . . . . . . . . . . . 35
. . . . . 27
. . . . 28
Contents 3
omreport about . . . . . . . . . . . . . . . . . . . . . 37
omreport chassis/omreport mainsystem
Commands
. . . . . . . . . . . . . . . . . . . . . . . . 38
omreport chassis/ omreport mainsystem
. . . . . 38
omreport chassis acswitch/omreport
mainsystem acswitch
. . . . . . . . . . . . . . . 38
omreport chassis batteries/omreport
mainsystem batteries
. . . . . . . . . . . . . . . . 39
omreport chassis bios/omreport
mainsystem bios
. . . . . . . . . . . . . . . . . . 40
omreport chassis biossetup/omreport
mainsystem biossetup
. . . . . . . . . . . . . . . 40
omreport chassis bmc/omreport
mainsystem bmc
. . . . . . . . . . . . . . . . . . 43
omreport chassis currents/omreport
mainsystem currents
. . . . . . . . . . . . . . . . 43
omreport chassis fans/omreport
mainsystem fans
. . . . . . . . . . . . . . . . . . 44
omreport chassis fancontrol/omreport
mainsystem fancontrol
. . . . . . . . . . . . . . . 44
omreport chassis firmware/omreport
mainsystem firmware
. . . . . . . . . . . . . . . . 44
omreport chassis frontpanel/omreport
mainsystem frontpanel
. . . . . . . . . . . . . . . 45
omreport chassis fru/omreport
mainsystem fru
. . . . . . . . . . . . . . . . . . . 45
omreport chassis hwperformance/omreport
mainsystem hwperformance
. . . . . . . . . . . . 45
omreport chassis info/omreport
mainsystem info
omreport chassis intrusion
. . . . . . . . . . . . . . . . . . 46
. . . . . . . . . . . . . 47
omreport chassis leds/omreport
mainsystem leds
. . . . . . . . . . . . . . . . . . 47
omreport chassis memory/omreport
mainsystem memory
. . . . . . . . . . . . . . . . 48
4 Contents
omreport chassis nics/omreport
mainsystem nics
. . . . . . . . . . . . . . . . . . 49
omreport chassis ports/omreport
mainsystem ports
. . . . . . . . . . . . . . . . . . 49
omreport chassis processors/omreport
mainsystem processors
. . . . . . . . . . . . . . 50
omreport chassis pwrmanagement/omreport
mainsystem pwrmanagement
. . . . . . . . . . . 54
omreport chassis pwrmonitoring/omreport
mainsystem pwrmonitoring
. . . . . . . . . . . . 55
omreport chassis pwrsupplies/omreport
mainsystem pwrsupplies
. . . . . . . . . . . . . . 57
omreport chassis remoteaccess/omreport
mainsystem remoteaccess
. . . . . . . . . . . . . 58
omreport chassis slots/omreport
mainsystem slots
. . . . . . . . . . . . . . . . . . 59
omreport chassis temps/omreport
mainsystem temps
. . . . . . . . . . . . . . . . . 59
omreport chassis volts/omreport
mainsystem volts
. . . . . . . . . . . . . . . . . . 60
omreport system Commands/omreport
servermodule Commands
. . . . . . . . . . . . . . . . 60
omreport system/omreport servermodule
Commands for Viewing Logs
. . . . . . . . . . . . 61
omreport system alertaction/omreport
servermodule alertaction
. . . . . . . . . . . . . 62
omreport system assetinfo/omreport
servermodule assetinfo
. . . . . . . . . . . . . . 64
omreport system events/omreport
servermodule events
. . . . . . . . . . . . . . . . 64
omreport system operatingsystem/omreport
servermodule operatingsystem
. . . . . . . . . . 66
omreport system pedestinations/omreport
servermodule pedestinations
. . . . . . . . . . . 66
omreport system platformevents/omreport
servermodule platformevents
. . . . . . . . . . . 68
. . . . . 60
Contents 5
omreport system recovery/omreport
servermodule recovery
. . . . . . . . . . . . . . . 68
omreport system shutdown/omreport
servermodule shutdown
. . . . . . . . . . . . . . 68
omreport system summary/omreport
servermodule summary
. . . . . . . . . . . . . . 68
omreport system thrmshutdown/omreport
servermodule thrmshutdown
. . . . . . . . . . . . 73
omreport system version/omreport
servermodule version
. . . . . . . . . . . . . . . 74
omreport preferences Commands
. . . . . . . . . . . . 75
4 omconfig: Managing Components
Using the Instrumentation Service
Conventions for Parameter Tables . . . . . . . . . 78
omconfig Command Summary
Help With the omconfig Command
omconfig about
. . . . . . . . . . . . . . . . . . . . . 86
omconfig chassis/omconfig mainsystem
omconfig chassis biossetup/omconfig
mainsystem biossetup
omconfig chassis bmc/omconfig
mainsystem bmc
omconfig chassis currents/omconfig
mainsystem currents
omconfig chassis fans/omconfig
mainsystem fans
omconfig chassis fancontrol/omconfig
mainsystem fancontrol
omconfig chassis frontpanel/omconfig
mainsystem frontpanel
. . . . . . . . . . . . . . 78
. . . . . . . . . . . 85
. . . . . . . . 87
. . . . . . . . . . . . . . . 87
. . . . . . . . . . . . . . . . . . 100
. . . . . . . . . . . . . . . . 100
. . . . . . . . . . . . . . . . . . 100
. . . . . . . . . . . . . . . 101
. . . . . . . . . . . . . . . 102
. . . . . 77
6 Contents
omconfig chassis info/omconfig
mainsystem info
. . . . . . . . . . . . . . . . . . 103
omconfig chassis leds/omconfig
mainsystem leds
. . . . . . . . . . . . . . . . . . 105
omconfig chassis memorymode/omconfig
mainsystem memorymode
. . . . . . . . . . . . . 105
omconfig chassis pwrmanagement/omconfig
mainsystem pwrmanagement
. . . . . . . . . . . 107
omconfig chassis pwrmonitoring/omconfig
mainsystem pwrmonitoring
. . . . . . . . . . . . 108
omconfig chassis remoteaccess/omconfig
mainsystem remoteaccess
. . . . . . . . . . . . . 110
omconfig chassis temps/omconfig
mainsystem temps
. . . . . . . . . . . . . . . . . 122
omconfig chassis volts/omconfig
mainsystem volts
. . . . . . . . . . . . . . . . . . 123
omconfig preferences
omconfig preferences cdvformat
omconfig preferences dirservice
omconfig preferences snmp
. . . . . . . . . . . . . . . . . . 125
. . . . . . . . . 125
. . . . . . . . . 126
. . . . . . . . . . . . 127
omconfig preferences useraccess
omconfig preferences webserver
omconfig system/omconfig servermodule
omconfig system alertaction/omconfig
servermodule alertaction
Commands for Clearing Logs
. . . . . . . . . . . . . 130
. . . . . . . . . . . 135
omconfig system pedestinations/omconfig
servermodule pedestinations
. . . . . . . . . . . 135
omconfig system platformevents/omconfig
servermodule platformevents
. . . . . . . . . . . 136
omconfig system events/omconfig
servermodule events
. . . . . . . . . . . . . . . . 139
omconfig system webserver/omconfig
servermodule webserver
. . . . . . . . . . . . . 142
. . . . . . . . 128
. . . . . . . . . 129
. . . . . . . 130
Contents 7
omconfig system recovery/omconfig
servermodule recovery
. . . . . . . . . . . . . . . 142
omconfig system shutdown/omconfig
servermodule shutdown
. . . . . . . . . . . . . . 143
omconfig system thrmshutdown/omconfig
servermodule thrmshutdown
. . . . . . . . . . . . 144
5 omconfig system or servermodule
assetinfo: Editing Cost of
Ownership Values
Overview . . . . . . . . . . . . . . . . . . . . . . . . . 147
User Level Required for Adding
Asset Information
. . . . . . . . . . . . . . . . . 147
. . . . . . . . . . . . . . . . . 147
8 Contents
Adding Acquisition Information
. . . . . . . . . . . . . 148
Example Commands for Adding
Acquisition Information
Adding Depreciation Information
. . . . . . . . . . . . . . 149
. . . . . . . . . . . . 150
Example Commands for Adding Depreciation
Information
. . . . . . . . . . . . . . . . . . . . . 151
Adding Extended Warranty Information
Example Command for Adding Extended
Warranty Information
Adding Lease Information
. . . . . . . . . . . . . . . 152
. . . . . . . . . . . . . . . . 153
Example Command for Adding Lease
Information
Adding Maintenance Information
. . . . . . . . . . . . . . . . . . . . . 154
. . . . . . . . . . . . 154
Example Command for Adding Maintenance
Information
. . . . . . . . . . . . . . . . . . . . . 155
. . . . . . . . 151
Adding Outsource Information . . . . . . . . . . . . . 156
Example Command for Adding Outsource
Information
. . . . . . . . . . . . . . . . . . . . . 157
Adding Owner Information
. . . . . . . . . . . . . . . 157
Example Command for Adding Owner
Information
Adding Service Contract Information
. . . . . . . . . . . . . . . . . . . . . 158
. . . . . . . . . . 159
Example Command for Adding Service
Information
Adding Support Information
. . . . . . . . . . . . . . . . . . . . . 159
. . . . . . . . . . . . . . . 160
Example Command for Adding Support
Information
Adding System Information
. . . . . . . . . . . . . . . . . . . . . 161
. . . . . . . . . . . . . . . 162
Example Command for Adding System
Information
Adding Warranty Information
. . . . . . . . . . . . . . . . . . . . . 162
. . . . . . . . . . . . . . 163
Example Command for Adding Warranty
Information
. . . . . . . . . . . . . . . . . . . . . 164
6 Using the Storage Management
Service
. . . . . . . . . . . . . . . . . . . . . . . . . 165
CLI Command Syntax . . . . . . . . . . . . . . . . . . 165
Syntax for Required, Optional, and Variable
Command Elements
. . . . . . . . . . . . . . . . . . . 166
User Privileges for omreport storage and
omconfig storage
. . . . . . . . . . . . . . . . . . . . 168
omreport Command . . . . . . . . . . . . . . . . . . . 168
Contents 9
omreport Storage Help . . . . . . . . . . . . . . . . . 169
omreport Controller Status
. . . . . . . . . . . . . 170
omreport Global Information (Smart
Thermal Shutdown Status, Hot Spare
Protection Policy)
omreport Battery Status
omreport Connector Status
omreport Enclosure Status
omreport Temperature Probe Status
omreport Fan Status
omreport Power Supply Status
omreport EMM Status
omreport Physical Disk Status
omreport Virtual Disk Status
. . . . . . . . . . . . . . . . . 170
. . . . . . . . . . . . . . 171
. . . . . . . . . . . . 171
. . . . . . . . . . . . . 172
. . . . . . . . 173
. . . . . . . . . . . . . . . . 174
. . . . . . . . . . . 175
. . . . . . . . . . . . . . . 176
. . . . . . . . . . . 177
. . . . . . . . . . . . 178
10 Contents
omconfig Global Commands
. . . . . . . . . . . . . . 178
omconfig Global Enable Smart Thermal
Shutdown
. . . . . . . . . . . . . . . . . . . . . . 179
omconfig Global Disable Smart Thermal
Shutdown
. . . . . . . . . . . . . . . . . . . . . . 179
omconfig Global Rescan Controller
omconfig Set Hot Spare Protection Policy
omconfig Controller Commands
omconfig Rescan Controller
. . . . . . . . . . . . . 181
. . . . . . . . . . . . 183
omconfig Enable Controller Alarm
omconfig Disable Controller Alarm
omconfig Quiet Controller Alarm
omconfig Test Controller Alarm
omconfig Reset Controller Configuration
omconfig Create Virtual Disk
. . . . . . . . . . . . 186
omconfig Set Controller Rebuild Rate
omconfig Set Background Initialization Rate
omconfig Set Reconstruct Rate
omconfig Set Check Consistency Rate
. . . . . . . . 180
. . . . . 180
. . . . . . . . . 184
. . . . . . . . 184
. . . . . . . . . . 185
. . . . . . . . . . 185
. . . . . 186
. . . . . . . 192
. . . 193
. . . . . . . . . . 193
. . . . . . . 194
omconfig Export the Controller Log . . . . . . . . 194
omconfig Import Foreign Configuration
. . . . . . 195
omconfig Import/Recover Foreign
Configuration
omconfig Clear Foreign Configuration
omconfig Set Patrol Read Mode
omconfig Start Patrol Read
omconfig Stop Patrol Read
omconfig Change Controller Properties
omconfig Storage Virtual Disk
omconfig Storage Controller
. . . . . . . . . . . . . . . . . . . . 195
. . . . . . . 196
. . . . . . . . . . 196
. . . . . . . . . . . . 197
. . . . . . . . . . . . 197
. . . . . . 198
. . . . . . . . . . . 199
. . . . . . . . . . . . 199
omconfig Virtual Disk Commands
omconfig Blink Virtual Disk
. . . . . . . . . . . . 201
omconfig Unblink Virtual Disk
omconfig Initialize Virtual Disk
omconfig Cancel Initialize Virtual Disk
omconfig Fast Initialize Virtual Disk
omconfig Slow Initialize Virtualize Disk
omconfig Cancel Background Initialize
omconfig Restore Dead Segments
omconfig Split Mirror
omconfig Unmirror
. . . . . . . . . . . . . . . 205
. . . . . . . . . . . . . . . . . 205
omconfig Assign Dedicated Hot Spare
omconfig Unassign Dedicated Hot Spare
omconfig Check Consistency
omconfig Cancel Check Consistency
omconfig Pause Check Consistency
omconfig Resume Check Consistency
omconfig Delete Virtual Disk
omconfig Format Virtual Disk
omconfig Reconfiguring Virtual Disks
omconfig Change Virtual Disk Policy
omconfig Rename Virtual Disk
. . . . . . . . . . . 200
. . . . . . . . . . . 201
. . . . . . . . . . . 202
. . . . . . . 202
. . . . . . . . 202
. . . . . . 203
. . . . . . 204
. . . . . . . . 204
. . . . . . 206
. . . . . 207
. . . . . . . . . . . 208
. . . . . . . 209
. . . . . . . . 209
. . . . . . . 210
. . . . . . . . . . . . 210
. . . . . . . . . . . 211
. . . . . . . 211
. . . . . . . 212
. . . . . . . . . . . 213
Contents 11
omconfig Physical Disk Commands . . . . . . . . . . . 213
omconfig Blink Physical Disk
omconfig Unblink Physical Disk
omconfig Prepare to Remove Physical Disk
omconfig Initialize Physical Disk
omconfig Offline Physical Disk
omconfig Offline Physical Disk
omconfig Online Physical Disk
omconfig Assign Global Hot Spare
omconfig Unassign Global Hot Spare
omconfig Rebuild Physical Disk
omconfig Cancel Rebuild Physical Disk
omconfig Remove Dead Segments
omconfig Clear Physical Disk
omconfig Cancel Clear Physical Disk
omconfig Cancel Replace Member
. . . . . . . . . . . . 214
. . . . . . . . . . 215
. . . . 216
. . . . . . . . . . 217
. . . . . . . . . . . 218
. . . . . . . . . . . 218
. . . . . . . . . . . 219
. . . . . . . . . 220
. . . . . . . 221
. . . . . . . . . . 222
. . . . . . 222
. . . . . . . . 223
. . . . . . . . . . . 224
. . . . . . . 225
. . . . . . . . 225
12 Contents
omconfig Battery Commands
. . . . . . . . . . . . . . 226
omconfig Recondition Battery
omconfig Start Battery Learn Cycle
omconfig Delay Battery Learn Cycle
omconfig Connector Commands
omconfig Rescan Connector
omconfig Enclosure Commands
omconfig Enable Enclosure Alarm
omconfig Disable Enclosure Alarm
omconfig Set Enclosure Asset Tag
omconfig Set Enclosure Asset Name
omconfig Set Temperature Probe
Thresholds
. . . . . . . . . . . . . . . . . . . . . 232
omconfig Reset Temperature Probe
Thresholds
. . . . . . . . . . . . . . . . . . . . . 233
. . . . . . . . . . . 226
. . . . . . . . 227
. . . . . . . . 227
. . . . . . . . . . . . 228
. . . . . . . . . . . . 228
. . . . . . . . . . . . . 229
. . . . . . . . . 230
. . . . . . . . 230
. . . . . . . . . 231
. . . . . . . 232
omconfig Set All Temperature Probe
Thresholds
. . . . . . . . . . . . . . . . . . . . . 234
omconfig Reset All Temperature Probe
Thresholds
omconfig Blink
. . . . . . . . . . . . . . . . . . . . . 235
. . . . . . . . . . . . . . . . . . . 235
7 Working With CLI Command
Results
. . . . . . . . . . . . . . . . . . . . . . . . . 237
Output Options for Command Results . . . . . . . 237
Controlling Command Output Display
Writing Command Output to a File
. . . . . . . 237
. . . . . . . . . 238
Selecting a Format for Your CLI
Command Output
. . . . . . . . . . . . . . . . . . 240
Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Index
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
Contents 13
14 Contents
Introduction
You can perform essential systems management tasks using Dell™
OpenManage™ Server Administrator’s graphical user interface (GUI) or the
command line interface (CLI).
The reporting and viewing features allow retrieval of overall health status for
systems on your network. At the component level, you can view information
about voltages, temperatures, fan’s
functioning, and many other critical component details. You can see a
detailed account of many relevant cost of ownership (COO) facts about your
system in a summary view. Version information for BIOS, firmware, operating
system, and all installed software is easy to retrieve.
Configuration features allow Server Administrator to perform essential tasks
described in detail in the following sections.
NOTE: You can use the CLI instead of the Server Administrator home page, and turn
the Server Administrator Web server off if you have security concerns. The CLI does
not use the Web server. Use the omconfig system webserver action=stop command
to turn off the Web server. The Web server starts automatically after a reboot, so this
command must be issued each time a system starts up. See ""omconfig system
webserver/omconfig servermodule webserver" on page 142" for more information.
What's New for Version 6.1
These are the release highlights of OpenManage Server Administrator:
• Support for configuration and display of the following BIOS setup options:
• Core multi processing
• Unified Extensible Firmware Interface (UEFI) boot option
• CPU C State option
• Embedded Video Controller
• Support for form factor and multiple slot information on modular systems
• Support for in-context launch of Server Administrator Web server
• Support for three new
• Support for the following system components:
xx1x
revolutions per minute (
systems.
RPM), memory
Introduction 15
• Reporting presence of optional iDRAC6 Enterprise card
• Provides an option to configure reporting of more attributes on
front panel LCD
• Reporting presence of iDRAC6 Enterprise and the size of storage,
if present
• Reporting of new PCI devices that are part of
xx1x
systems
• Display of the CPU turbo mode
• Display of new memory types (DDR3 Registered,
DDR3 Unregistered)
• Display of new slot types (PCIe Gen1/2)
• Enabling/disabling Non-Uniform Memory Architecture
(Node Interleaving) during deployment
• Enabling Network Controller-Sideband Interface support on each of
the LOMs on an individual basis for all LOMs
• Reporting memory operating modes (optimizer, mirror, advanced
ECC)
• Support for NICS receive and transmit statistics.
• Configuring AC Power Recovery delay
• Support for configuration and reporting Serial Address Select
• Enhanced power monitoring support:
• Reporting of power consumption values in BTU (British Thermal
Unit), as well as Watts.
• Support for Peak power headroom and instantaneous headroom
• Support for user-definable power budget cap
• Support for reporting of maximum potential power consumption and
minimum potential power consumption
• Support for reporting input power rating of power supply
• Support for power profile configuration
• Support for events alerting capability for peak power consumption
16 Introduction
• Inclusion of Internet Protocol version 6:
• This release supports IPv6, in addition to IPv4.
NOTE: For the supported operating systems list, see the Dell Systems Software
Support Matrix located at DVD_Drive\docs\readme\PEOSOM on the Dell-provided
media or on the Dell support website at support.dell.com.
NOTE: CLI commands are not supported on systems with VMware® ESXi
operating system.
Using CLI Commands from Windows Command Prompts
If you are running the Microsoft Windows® operating system, use the 32-bit
command prompt to issue a Server Administrator CLI command. You can
access the 32-bit command prompt by clicking the Start button and pointing
to Programs→ Accessories→ Command Prompt shortcut, or by clicking the
Start button, selecting Run, and typing cmd.exe in the Run dialog box.
Do not type command into the Run dialog box to launch a command line
window; this activates the MS-DOS
environment variable limitations that can cause subtle problems with
the CLI.
®
emulator command.com, which has
Primary CLI Commands
The commands that carry out the functions of Server Administrator are:
•
omconfig
•
omhelp
•
omreport
The omconfig command writes values that you assign to an object's
properties. You can specify values for warning thresholds on components or
prescribe what action your system is to take when a certain warning or failure
event occurs. You can also use the omconfig command to assign specific
values to your system's asset information parameters, such as the purchase
price of the system, the system's asset tag, or the system's location.
Introduction 17
The omhelp command displays short text help for CLI commands.
The shorthand equivalent of omhelp is the command for which you want
help followed by -?. For example, to display help for the omreport command,
type one of the following commands:
omhelp omreport
omreport -?
The omreport command produces reports of your system’s management
information.
NOTE: For an overall summary of CLI commands, type omhelp.
Table 1-1 lists the primary CLI commands used by Server Administrator.
This guide contains a section for each primary command.
Table 1-1. CLI Commands and Sections in This Guide
Primary CLI
Command
omconfig "omconfig: Managing Components
omhelp "Using the omhelp Command"
omreport "omreport: Viewing System Status
NOTE: omupdate commands are no longer supported in Server Administrator and
are replaced by Dell Update Package or Server Update Utility commands. To update
the different components, download the Dell Update Package and run <package
name> /s [/f]. See the Dell Update Packages for Microsoft Windows Operating Systems
User’s Guide, the Dell Update Packages for Linux User’s Guide, or the Server Update
Utility User’s Guide on the Dell Systems Management tools and Documentation DVD
or on the Dell Support website at support.dell.com for more information on
corresponding CLI syntax.
Section Title Related Sections
"omconfig system or
Using the Instrumentation Service"
Using the Instrumentation Service"
servermodule assetinfo: Editing
Cost of Ownership Values"
Additional useful topics about the CLI include:
• "Working With CLI Command Results"
• "Glossary"
18 Introduction
CLI Error Checking and Error Messages
When you type CLI commands, the CLI checks these commands for correct
syntax. If you enter a command and the command is executed successfully,
a message displays, stating that your command has been successful.
Success Messages
When you type a successful omconfig command, data for that
component displays.
The following omconfig command examples show valid CLI commands and
their success messages:
Command:
omconfig chassis temps index=0 warnthresh=default
Message:
Temperature probe warning threshold value(s) set
successfully.
Command:
omconfig chassis biossetup attribute=speaker
setting=on
Message:
BIOS setup configured successfully.
Command:
omconfig system assetinfo info=depreciation
duration=6
Message:
Asset information set successfully.
Failure Messages
CLI failure messages provide reasons why some commands do not succeed.
Some common reasons why commands fail include syntax errors and
components that are not present. Many error messages provide syntax
information that you can use to execute the command successfully.
Introduction 19
If you try to execute a command for a component or feature not present in
your system configuration, the error message states that the component is not
present.
Command:
omconfig chassis volts index=3 minwarnthresh=
3.3000
Example message:
Error! Number with up to 3 digits after decimal
point expected, read 3.3000
The value given by the command specifies more than
3 digits after the decimal point. A valid minimum
warning threshold value for volts contains up to
3 digits after the decimal point.
Type:
omconfig chassis volts index=3 minwarnthresh=3.300
When you enter the revised command with three decimal points, you receive
another error message:
Error! This voltage probe min warning threshold
must be between 11.400 and 12.480.
Revised command:
omconfig chassis volts index=3 minwarnthresh=
11.500
Message:
Voltage probe warning threshold(s) set
successfully.
Scripting and Comparing With the CLI
The Server Administrator CLI allows administrators to write batch programs
or scripts to be executed by the operating system. For an enterprise with many
systems, an administrator could write a configuration script that specified the
warning thresholds for each major component of a system and also specified
a set of actions that the administrator wants each system to take in case of
20 Introduction
a warning or failure event. In the most critical cases, the administrator could
write a script so that the system shuts down to prevent damage. The
administrator could then distribute and execute the script to many managed
systems at the same time. Such a scenario facilitates configuring any number
of new systems acquired by a company and makes implementation of new
system administration policies easier across many existing systems that
require reconfiguration.
A similar scenario could be used to populate a large number of newly acquired
systems with detailed asset information. Much of the information would be the
same, such as the manufacturer or lessor of the system, whether support for the
system is outsourced, name of the system's insurance company, method of
depreciation, and so on. Any variable that is common to all systems could be
scripted, sent to all managed systems, and executed. Asset information that is
unique to a system could be scripted as a group and sent to that managed
node for execution. For example, a script could specify values for all unique
variables such as owner, primary user phone number, asset tag, and so on.
Scripts to populate unique values would set all unique variables at once rather
than one by one through the system's command line.
In many cases, the CLI allows a user with a very well-defined task in mind to
retrieve information about the system rapidly. If a user wants to review a
comprehensive summary of all system components and save that summary
information to a file for comparison with later system states, the CLI is ideal.
Using CLI commands, administrators can write batch programs or scripts to
execute at specific times. When these programs execute, they can capture
reports on components of interest, such as fan RPMs during periods of high
system usage compared with the same measurements at times of lowest
system usage. Command results can be routed to a file for later analysis.
Reports can help administrators gain information that can be used to adjust
usage patterns, to justify purchasing new system resources, or to focus on the
health of a problem component.
Command Syntax Overview
Commands vary in complexity. The simplest command has only command
level 1. The omhelp command is a simple command. When you type
omhelp, a list of the main CLI commands is displayed.
Introduction 21
The next level of complexity includes commands that contain command
levels 1 and 2. All of the about commands are examples of command level 2
complexity. The omconfig about and omreport about commands cause a very
brief summary to display. The summary shows version information for the
systems management software installed on your system; for example, Server
Administrator 1.x.
Some commands have command level 1 and command level 2 and one
name=value pair. Consider the following example command that instructs
Server Administrator for more details about the environment for Server
Administrator:
omreport about details=true
Command level 1 is omreport, command level 2 is about, and the name=
value pair is
details=true.
Many commands use command level 1, command level 2, and command
level 3, but do not require any parameters (name=value pairs). Most
omreport commands are of this type. For example:
omreport system alertaction
causes a list of alert actions that are configured for components on your
system to be displayed.
The most complex commands have all three command levels and can
have multiple name=value pairs. An example of two name=value pairs:
omconfig system assetinfo info=depreciation
duration=3
An example of nine name=value pairs:
omconfig system assetinfo info=acquisition
purchasecost=
purchasedate=<
expensed=<
<n> waybill=<n> installdate=<
mmddyy
yes | no
> ponum=<n> signauth=<
> costcenter=<
text
mmddyy
text
>
In each section, command syntax and other information about commands is
formatted with any of the following fields that apply:
command
level 1
command
level 2
command
level 3
name=value
pair 1
name=value
pair 2
22 Introduction
>
>
Using the omhelp Command
The omhelp command and its equivalent, <command> -?, accesses the CLI's
detailed help text interface. You can get help at several levels of detail.
Each fully qualified CLI command may have a variable number of distinct
parts: the command (command level 1), one or more subcommands
(command level 2 and command level 3, if present), and one or more name=
value pair(s).
By appending -? (space-dash-question mark) to any command, you can get
help for that command.
Example Help Commands
When you type omconfig -?, you get general help about the omconfig
command. The help at this level lists the available subcommands for
omconfig:
•about
• preferences
•chassis
• system
When you type omconfig system -?, CLI help lists all the
subcommands available for omconfig system:
• alertaction
• alertlog
• assetinfo
• cmdlog
•esmlog
• events
• platformevents
• pedestinations
• recovery
Using the omhelp Command 23
•shutdown
• thrmshutdown
• webserver
Figure 2-1 shows the levels of help for a command.
Figure 2-1. Different Levels of Help for a Command
You can also parse the omconfig system assetinfo command as follows:
<command level 1 command level 2 command level 3>
<name=value pair 1> [name=value pair 2]
where command levels 1, 2, and 3 are represented by omconfig system assetinfo,
name=value pair 1 is represented by info=depreciation, and name=value pair 2
is represented by method=straightline.
To set your depreciation method to straight line, type:
omconfig system assetinfo info=depreciation
method=straightline
The CLI responds with the following message:
Asset information set successfully.
When you type omconfig system assetinfo -?, the help that
displays provides information about assigning values for the name and option
fields. Partial results for the request omconfig system assetinfo -? are as
follows:
assetinfo Set asset information.
24 Using the omhelp Command
For one info value, specify one or more optional parameter(s).
Table 2-1 displays the optional parameters for info=acquisition:
Table 2-1. Optional Parameters
Info Value Optional parameters
Info=acquisition purchasecost=<num>
waybill=<num>
installdate=<mmddyy>
purchasedate=<mmddyy>
ponum=<num>
signauth=<text>
expensed=<yes|no>
costcenter=<text>
info=depreciation
method=<text>
duration=<num>
percent=<percent>
unit=<months|years|unknown>
Using the omhelp Command 25
26 Using the omhelp Command
omreport: Viewing System Status Using the Instrumentation Service
The omreport command allows you to see detailed information about your
system components. You can retrieve summaries for many system
components at one time, or you can get details about a specific component.
This chapter shows you how to get reports with the level of detail that you
want.
Commands documented in this chapter vary in whether they define the fields that
appear in the results of a particular omreport command. Fields are defined only
if they have a special or less familiar use.
As with all other components, you can use omreport to view component
status, and omconfig to manage a component. For information on
configuring components for management, see "omconfig: Managing
Components Using the Instrumentation Service."
You can use omreport commands to get 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 omreport chassis
temps to display a list of probes and their indexes.
Table 3-1. System Availability for the omreport Command
Command Level 1 Command Level 2 Applicable To
omreport modularenclosure
servermodule
mainsystem
system
chassis
preferences
omreport: Viewing System Status Using the Instrumentation Service 27
Modular system
Modular system
Modular system
Non-modular system
Non-modular system
Modular/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.
Command Summary of the omreport Command
NOTE: Although this chapter lists all possible omreport commands, the commands
available on your system depend on your system configuration. The results that
display for the omreport command vary from one system to another. Data displays
for installed components only.
NOTE: When a system includes an external chassis, the displayed results vary by
operating system. On SUSE
®
systems, omreport commands display external chassis information in
Linux
a separate section after the main chassis information. On Microsoft
systems, data about the external chassis does not appear in the omreport output.
Table 3-2 is a high-level summary of the omreport command. The column
titled "Command level 1" shows the omreport command at its most general.
"Command level 2" shows the major objects or components that you can view
using omreport (about, chassis, storage, and system). "Command level 3" lists
the specific objects and components for which you can view reports. "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
omreport. More details about syntax and use of the command appear later in
this section.
Table 3-2 shows the omreport commands available for about, system, and
main system chassis. For information about viewing storage components,
see "omreport: Viewing System Status Using the Instrumentation Service."
®
Linux Enterprise Server and Red Hat® Enterprise
®
Windows®
28 omreport: Viewing System Status Using the Instrumentation Service
Table 3-2. Command Level 1, Level 2, and Level 3 for omreport
Command
Level 1
omreport
Command Level 2 Command
Level 3
User
Privilege
Required
Use
modularenclosure U, P, A Shows information
for all the modular
chassis.
about U, P, A Shows version
number and
properties for Server
Administrator.
details=true U, P, A Displays information
for all the Server
Administrator
programs installed.
chassis/mainsystem U, P, A Shows the general
status of all the main
components.
acswitch U, P, A Shows failover
settings where
redundant AC power
lines are supported in
a system.
batteries U, P, A Shows the properties
set for batteries.
bios U, P, A Shows BIOS
information such as
manufacturer,
version, and date last
updated.
biossetup A Shows BIOS setup
properties configured
during system boot.
fancontrol U, P, A Shows the properties
set for fan speed.
omreport: Viewing System Status Using the Instrumentation Service 29
Table 3-2. Command Level 1, Level 2, and Level 3 for omreport (continued)
Command
Level 1
Command Level 2 Command
Level 3
fans U, P, A Shows the status and
firmware U, P, A Shows firmware
frontpanel U, P, A Shows whether the
fru U, P, A Shows the Field
hwperformance U, P, A Shows the status and
info U, P, A Shows a status
intrusion U, P, A Shows the status of
User
Privilege
Required
Use
thresholds for system
fans.
properties such as
version, date of last
update, and whether
the firmware
is updatable.
front panel button
settings, such as the
Power button and/or
Nonmasking
Interrupt (NMI)
button (if present on
the system), are
enabled or disabled.
Replaceable Unit
(FRU) information.
cause for the system’s
performance
degradation.
summary for main
system chassis
components.
the system’s intrusion
sensor(s).
30 omreport: Viewing System Status Using the Instrumentation Service
Loading...