Dell OpenManage Server Administrator Version 6.3 User Manual
Dell OpenManage
Server Administrator
Version 6.3
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 publication is subject to change without notice.
© 2010 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 Server
United States and/or other countries. SUSE™ is a registered trademark of Novell Inc. in the United
States and other countries. Red Hat
Hat, Inc. in the United States and other countries. Intel
trademarks and Intel386™ is a trademark of Intel Corporation in the United States and other countries.
®
AMD
Devices Inc. UNIX
of Rambus Inc.
Other trademarks and trade names may be used in this publication 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 itsown.
®
are either trademarks or registered trademarks of Microsoft Corporation in the
, AMD Opteron™, AMD-V™, and AMD PowerNow!™ are trademarks of Advanced Micro
®
is a registered trademark of The Open Group. Rambus® is a registered trademark
®
, Windows®, Active Directory®, Hyper-V™, MS-DOS®, and
®
and Red Hat Enterprise Linux® are registered trademarks of Red
®
, Pentium®, and Itanium® are registered
July 2010
Contents
1 Introduction . . . . . . . . . . . . . . . . . . . . . . . 15
What's New in Version 6.3 . . . . . . . . . . . . . . . 16
Using CLI Commands from Windows Command
Prompts
Primary CLI Commands . . . . . . . . . . . . . . . . . 16
. . . . . . . . . . . . . . . . . . . . . . . . . 16
CLI Error Checking and Error Messages
Success Messages
Failure Messages
Scripting and Comparing With the CLI
Command Syntax Overview
. . . . . . . . . . . . . . . . 18
. . . . . . . . . . . . . . . . . 19
. . . . . . . . . . . . . . . 21
. . . . . . . . 18
. . . . . . . . . 20
2 Using the omhelp Command . . . . . . . . . . 23
Example Help Commands . . . . . . . . . . . . . . . . 23
3 omreport: Viewing System Status
Using the Instrumentation Service 27
Conventions for Parameter Tables . . . . . . . . . 28
Command Summary of the omreport Command
Help With the omreport Command . . . . . . . . . . . 35
omreport modularenclosure
. . . . . . . . . . . . . . 35
. . . . 28
Contents 3
omreport about . . . . . . . . . . . . . . . . . . . . . 36
omreport chassis/omreport mainsystem Commands
omreport chassis/ omreport mainsystem
. . . . . 37
omreport chassis acswitch/omreport
mainsystem acswitch
. . . . . . . . . . . . . . . 38
omreport chassis batteries/omreport
mainsystem batteries . . . . . . . . . . . . . . . . 39
omreport chassis bios/omreport mainsystem
bios . . . . . . . . . . . . . . . . . . . . . . . . . 39
omreport chassis biossetup/omreport
mainsystem biossetup
. . . . . . . . . . . . . . . 39
omreport chassis currents/omreport
mainsystem currents . . . . . . . . . . . . . . . . 43
omreport chassis removableflashmedia/omreport
mainsystem removableflashmedia . . . . . . . . . 43
omreport chassis fans/omreport
mainsystem fans
. . . . . . . . . . . . . . . . . . 44
omreport chassis firmware/omreport
mainsystem firmware . . . . . . . . . . . . . . . . 45
omreport chassis frontpanel/omreport
mainsystem frontpanel . . . . . . . . . . . . . . . 45
omreport chassis fru/omreport mainsystem
fru
. . . . . . . . . . . . . . . . . . . . . . . . . . 45
omreport chassis hwperformance/omreport
mainsystem hwperformance . . . . . . . . . . . . 46
omreport chassis info/omreport mainsystem
info . . . . . . . . . . . . . . . . . . . . . . . . . 46
omreport chassis intrusion
. . . . . . . . . . . . . 47
omreport chassis leds/omreport mainsystem
leds . . . . . . . . . . . . . . . . . . . . . . . . . 48
omreport chassis memory/omreport mainsystem
memory
. . . . . . . . . . . . . . . . . . . . . . . 48
omreport chassis nics/omreport mainsystem
nics . . . . . . . . . . . . . . . . . . . . . . . . . 50
omreport chassis ports/omreport mainsystem
ports . . . . . . . . . . . . . . . . . . . . . . . . 51
. . 37
4 Contents
omreport chassis processors/omreport
mainsystem processors . . . . . . . . . . . . . . 51
omreport chassis pwrmanagement/omreport
mainsystem pwrmanagement . . . . . . . . . . . 55
omreport chassis pwrmonitoring/omreport
mainsystem pwrmonitoring . . . . . . . . . . . . 56
omreport chassis pwrsupplies/omreport
mainsystem pwrsupplies
. . . . . . . . . . . . . . 58
omreport chassis remoteaccess/omreport
mainsystem remoteaccess . . . . . . . . . . . . . 59
omreport chassis slots/omreport mainsystem
slots . . . . . . . . . . . . . . . . . . . . . . . . 60
omreport chassis temps/omreport mainsystem
temps
. . . . . . . . . . . . . . . . . . . . . . . . 60
omreport chassis volts/omreport mainsystem
volts . . . . . . . . . . . . . . . . . . . . . . . . 61
omreport system Commands/omreport servermodule
Commands
. . . . . . . . . . . . . . . . . . . . . . . . 61
omreport system/omreport servermodule
Commands for Viewing Logs
. . . . . . . . . . . . 62
. . . . . 61
omreport system alertaction/omreport
servermodule alertaction . . . . . . . . . . . . . 63
omreport system assetinfo/omreport
servermodule assetinfo . . . . . . . . . . . . . . 65
omreport system events/omreport
servermodule events
. . . . . . . . . . . . . . . . 65
omreport system operatingsystem/omreport
servermodule operatingsystem
. . . . . . . . . . 67
omreport system pedestinations/omreport
servermodule pedestinations . . . . . . . . . . . 68
omreport system platformevents/omreport
servermodule platformevents
. . . . . . . . . . . 69
omreport system recovery/omreport
servermodule recovery . . . . . . . . . . . . . . 69
omreport system shutdown/omreport
servermodule shutdown . . . . . . . . . . . . . . 70
Contents 5
omreport system summary/omreport
servermodule summary . . . . . . . . . . . . . . 70
omreport system thrmshutdown/omreport
servermodule thrmshutdown . . . . . . . . . . . . 76
omreport system version/omreport servermodule
version . . . . . . . . . . . . . . . . . . . . . . . 76
omreport preferences Commands . . . . . . . . . . . . 77
4 omconfig: Managing Components
Using the Instrumentation Service . . . . . 79
Conventions for Parameter Tables . . . . . . . . . 80
omconfig Command Summary
. . . . . . . . . . . . . . 80
Help With the omconfig Command . . . . . . . . . . . 86
omconfig about
omconfig chassis/omconfig mainsystem
. . . . . . . . . . . . . . . . . . . . . 87
. . . . . . . . 89
omconfig chassis biossetup/omconfig
mainsystem biossetup
. . . . . . . . . . . . . . . 89
omconfig chassis currents/omconfig
mainsystem currents . . . . . . . . . . . . . . . . 104
omconfig chassis fans/omconfig
mainsystem fans
. . . . . . . . . . . . . . . . . . 104
omconfig chassis frontpanel/omconfig
mainsystem frontpanel
. . . . . . . . . . . . . . . 105
omconfig chassis info/omconfig
mainsystem info . . . . . . . . . . . . . . . . . . 107
omconfig chassis leds/omconfig
mainsystem leds
. . . . . . . . . . . . . . . . . . 108
omconfig chassis memorymode/omconfig
mainsystem memorymode . . . . . . . . . . . . . 109
omconfig chassis pwrmanagement/omconfig
mainsystem pwrmanagement . . . . . . . . . . . 110
6 Contents
omconfig chassis pwrmonitoring/omconfig
mainsystem pwrmonitoring . . . . . . . . . . . . 112
omconfig chassis remoteaccess/omconfig
mainsystem remoteaccess . . . . . . . . . . . . . 114
omconfig chassis temps/omconfig mainsystem
temps . . . . . . . . . . . . . . . . . . . . . . . . 126
omconfig chassis volts/omconfig mainsystem
volts
. . . . . . . . . . . . . . . . . . . . . . . . 127
omconfig preferences
omconfig preferences cdvformat
omconfig preferences dirservice
. . . . . . . . . . . . . . . . . . 129
. . . . . . . . . 129
. . . . . . . . . 129
omconfig preferences snmp . . . . . . . . . . . . 130
omconfig preferences useraccess
omconfig preferences webserver
omconfig system/omconfig servermodule
. . . . . . . . 132
. . . . . . . . . 132
. . . . . . . 134
omconfig system alertaction/omconfig
servermodule alertaction
. . . . . . . . . . . . . 134
Commands for Clearing Logs . . . . . . . . . . . 139
omconfig system pedestinations/omconfig
servermodule pedestinations
. . . . . . . . . . . 139
omconfig system platformevents/omconfig
servermodule platformevents
. . . . . . . . . . . 140
omconfig system events/omconfig
servermodule events . . . . . . . . . . . . . . . . 143
omconfig system webserver/omconfig
servermodule webserver
. . . . . . . . . . . . . 146
omconfig system recovery/omconfig
servermodule recovery
. . . . . . . . . . . . . . 146
omconfig system shutdown/omconfig
servermodule shutdown . . . . . . . . . . . . . . 147
omconfig system thrmshutdown/omconfig
servermodule thrmshutdown
. . . . . . . . . . . 148
Contents 7
5 omconfig system or servermodule
assetinfo: Editing Cost of Ownership
Values . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Overview . . . . . . . . . . . . . . . . . . . . . . . . . 151
User Level Required for Adding Asset
Information
Adding Acquisition Information . . . . . . . . . . . . . 152
Example Commands for Adding Acquisition
Information
Adding Depreciation Information . . . . . . . . . . . . 154
Example Commands for Adding Depreciation
Information
Adding Extended Warranty Information . . . . . . . . 155
Example Command for Adding Extended
Warranty Information
Adding Lease Information . . . . . . . . . . . . . . . . 157
Example Command for Adding Lease
Information
. . . . . . . . . . . . . . . . . . . . . 151
. . . . . . . . . . . . . . . . . . . . . 153
. . . . . . . . . . . . . . . . . . . . . 155
. . . . . . . . . . . . . . . 156
. . . . . . . . . . . . . . . . . . . . . 158
8 Contents
Adding Maintenance Information
. . . . . . . . . . . . 158
Example Command for Adding Maintenance
Information
Adding Outsource Information
. . . . . . . . . . . . . . . . . . . . . 159
. . . . . . . . . . . . . 160
Example Command for Adding Outsource
Information
. . . . . . . . . . . . . . . . . . . . . 161
Adding Owner Information . . . . . . . . . . . . . . . 161
Example Command for Adding Owner
Information
. . . . . . . . . . . . . . . . . . . . . 162
Adding Service Contract Information . . . . . . . . . . 162
Example Command for Adding Service
Information . . . . . . . . . . . . . . . . . . . . . 163
Adding Support Information
. . . . . . . . . . . . . . . 164
Example Command for Adding Support
Information
Adding System Information
. . . . . . . . . . . . . . . . . . . . . 165
. . . . . . . . . . . . . . . 166
Example Command for Adding System
Information
Adding Warranty Information
. . . . . . . . . . . . . . . . . . . . . 166
. . . . . . . . . . . . . . 167
Example Command for Adding Warranty
Information
. . . . . . . . . . . . . . . . . . . . . 168
6 Using the Storage Management
Service . . . . . . . . . . . . . . . . . . . . . . . . . 169
CLI Command Syntax . . . . . . . . . . . . . . . . . . 169
Syntax for Required, Optional, and Variable
Command Elements
User Privileges for omreport storage and
omconfig storage
omreport Command
. . . . . . . . . . . . . . . . . . . 170
. . . . . . . . . . . . . . . . . . . . 172
. . . . . . . . . . . . . . . . . . . 172
omreport Storage Help
omreport Controller Status
. . . . . . . . . . . . . . . . . 173
. . . . . . . . . . . . . 174
omreport Global Information (Smart Thermal
Shutdown Status, Hot Spare
Protection Policy) . . . . . . . . . . . . . . . . . 174
omreport Battery Status
omreport Connector Status
. . . . . . . . . . . . . . 175
. . . . . . . . . . . . 175
omreport Enclosure Status . . . . . . . . . . . . . 176
omreport Temperature Probe Status
. . . . . . . 178
Contents 9
omreport Fan Status . . . . . . . . . . . . . . . . 179
omreport Power Supply Status
. . . . . . . . . . . 180
omreport EMM Status . . . . . . . . . . . . . . . 181
omreport Enclosure Slot Occupancy Report
omreport Physical Disk Status
. . . . . . . . . . . 183
. . . . 182
omreport Virtual Disk Status . . . . . . . . . . . . 184
omconfig Global Commands . . . . . . . . . . . . . . 184
omconfig Global Enable Smart Thermal
Shutdown
. . . . . . . . . . . . . . . . . . . . . . 185
omconfig Global Disable Smart Thermal
Shutdown
. . . . . . . . . . . . . . . . . . . . . . 185
omconfig Global Rescan Controller . . . . . . . . 186
omconfig Set Hot Spare Protection Policy
. . . . . 186
omconfig Controller Commands
omconfig Rescan Controller
omconfig Enable Controller Alarm
omconfig Disable Controller Alarm
. . . . . . . . . . . . . 187
. . . . . . . . . . . . 190
. . . . . . . . . 190
. . . . . . . . 191
omconfig Quiet Controller Alarm . . . . . . . . . . 191
omconfig Test Controller Alarm
omconfig Reset Controller Configuration
. . . . . . . . . . 192
. . . . . 192
omconfig Create Virtual Disk . . . . . . . . . . . . 193
omconfig Set Controller Rebuild Rate
. . . . . . . 199
omconfig Set Background Initialization Rate
omconfig Set Reconstruct Rate
omconfig Set Check Consistency Rate
omconfig Export the Controller Log
omconfig Import Foreign Configuration
. . . . . . . . . . 200
. . . . . . . 201
. . . . . . . . 201
. . . . . . 202
omconfig Import/Recover Foreign
Configuration
. . . . . . . . . . . . . . . . . . . . 202
omconfig Clear Foreign Configuration . . . . . . . 203
omconfig Physical Disk Power Management
omconfig Set Patrol Read Mode
. . . . . . . . . . 204
omconfig Start Patrol Read . . . . . . . . . . . . 205
. . . 200
. . . 203
10 Contents
omconfig Stop Patrol Read . . . . . . . . . . . . 205
omconfig Change Controller Properties
. . . . . . 206
omconfig Storage Virtual Disk . . . . . . . . . . . 206
omconfig Storage Controller
. . . . . . . . . . . . 207
omconfig Virtual Disk Commands
omconfig Blink Virtual Disk
omconfig Unblink Virtual Disk
omconfig Initialize Virtual Disk
. . . . . . . . . . . 208
. . . . . . . . . . . . 209
. . . . . . . . . . . 209
. . . . . . . . . . . 210
omconfig Cancel Initialize Virtual Disk . . . . . . . 210
omconfig Fast Initialize Virtual Disk
omconfig Slow Initialize Virtualize Disk
. . . . . . . . 211
. . . . . . 212
omconfig Cancel Background Initialize . . . . . . 212
omconfig Restore Dead Segments
omconfig Split Mirror
. . . . . . . . . . . . . . . 213
. . . . . . . . 213
omconfig Unmirror . . . . . . . . . . . . . . . . . 214
omconfig Assign Dedicated Hot Spare
omconfig Unassign Dedicated Hot Spare
. . . . . . 215
. . . . . 216
omconfig Check Consistency . . . . . . . . . . . 217
omconfig Cancel Check Consistency
omconfig Pause Check Consistency
. . . . . . . 217
. . . . . . . . 218
omconfig Resume Check Consistency . . . . . . . 218
omconfig Delete Virtual Disk
omconfig Format Virtual Disk
omconfig Reconfiguring Virtual Disks
omconfig Change Virtual Disk Policy
omconfig Rename Virtual Disk
omconfig Clear Virtual Disk Bad Blocks
. . . . . . . . . . . . 219
. . . . . . . . . . . 219
. . . . . . . 220
. . . . . . . 221
. . . . . . . . . . . 222
. . . . . . 222
omconfig Physical Disk Commands . . . . . . . . . . 223
omconfig Blink Physical Disk
. . . . . . . . . . . 224
omconfig Unblink Physical Disk . . . . . . . . . . 225
omconfig Prepare to Remove Physical Disk
omconfig Initialize Physical Disk
. . . . . . . . . . 226
. . . . 225
Contents 11
omconfig Offline Physical Disk . . . . . . . . . . . 227
omconfig Offline Physical Disk
. . . . . . . . . . . 227
omconfig Online Physical Disk . . . . . . . . . . . 228
omconfig Assign Global Hot Spare
omconfig Unassign Global Hot Spare
. . . . . . . . . 229
. . . . . . . 230
omconfig Rebuild Physical Disk . . . . . . . . . . 231
omconfig Cancel Rebuild Physical Disk
omconfig Remove Dead Segments
. . . . . . 232
. . . . . . . . 232
omconfig Clear Physical Disk . . . . . . . . . . . 233
omconfig Cancel Clear Physical Disk
omconfig Cancel Replace Member
. . . . . . . 234
. . . . . . . . 235
omconfig Battery Commands
omconfig Recondition Battery
omconfig Start Battery Learn Cycle
. . . . . . . . . . . . . . 235
. . . . . . . . . . . 235
. . . . . . . . 236
omconfig Delay Battery Learn Cycle . . . . . . . . 236
omconfig Connector Commands . . . . . . . . . . . . 237
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
. . . . . . . . . . . . 237
. . . . . . . . . . . . . 238
. . . . . . . . . 240
. . . . . . . . 240
. . . . . . . . . 241
. . . . . . . 242
. . . 242
omconfig Reset Temperature Probe
Thresholds
. . . . . . . . . . . . . . . . . . . . . 243
omconfig Set All Temperature Probe
Thresholds . . . . . . . . . . . . . . . . . . . . . 244
omconfig Reset All Temperature Probe
Thresholds
. . . . . . . . . . . . . . . . . . . . . 245
omconfig Blink . . . . . . . . . . . . . . . . . . . 245
12 Contents
7 Working With CLI Command
Results . . . . . . . . . . . . . . . . . . . . . . . . . 251
Output Options for Command Results . . . . . . . 251
Controlling Command Output Display
Writing Command Output to a File
Selecting a Format for Your CLI Command
Output . . . . . . . . . . . . . . . . . . . . . . . 254
. . . . . . . 251
. . . . . . . . . 252
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Contents 13
14 Contents
1
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.
Other features of OpenManage Server Administrator are as follows:
• Support for displaying and configuring BIOS settings for all supported
platforms.
• Support for latest version of vendor libraries.
• Support for managed node components on all platforms released after
OpenManage Server Administrator version 6.2.
• Support for configuring boot order and adding or removing devices from
the boot list using CLI.
• Support for SHA 256 certificate authentication.
• Support for installing OMSA on Linux with specific packages, according to
its distribution, version, or architecture.
Configuration features allow Server Administrator to perform essential tasks
described in detail in the following sections.
revolutions per minute (
RPM), memory
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 146 for more information.
NOTE: After installing the Dell OpenManage Server Administrator, ensure that you
log out and log in to reset the path to access Dell OpenManage CLI utilities.
Introduction 15
NOTE: For information on terms used in this document, see the Glossary on the Dell
support website.
What's New in Version 6.3
Following are the new features of OpenManage Server Administrator 6.3:
• Support for TCM (Trusted Cryptographic Module)
• Support for power management of physical disks attached to the controller
• Support for writing the security parameters of the controller
• Support for the following:
– vFlash type and available size in vFlash media details
– NIC Team interface properties in
– Slot details in
NOTE: For the supported operating systems list, see the Dell Systems Software
Support Matrix. To access this document, go to support.dell.com/manuals, click
Software, and select your product.
NOTE: CLI commands are not supported on systems with VMware ESXi operating
system.
omreport controller
omreport chassis
command
command
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 emulator command.com, which has
environment variable limitations that can cause subtle problems with
the CLI.
Primary CLI Commands
The commands that carry out the functions of Server Administrator are:
16 Introduction
•
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.
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
omhelp ""Using the omhelp Command" on
omreport ""omreport: Viewing System Status
Section Title Related Sections
Components Using the
Instrumentation Service" on
page 79"
page 23"
Using the Instrumentation Service"
on page 27"
""omconfig system or
servermodule assetinfo: Editing
Cost of Ownership Values" on
page 151"
Introduction 17
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 DellUpdate Packages for Linux User’ s Guide, or the Se rver Update
Utility User’s Guide on the Dell Support website at support.dell.com/manuals for
more information on corresponding CLI syntax.
Additional useful topics about the CLI include:
• ""Working With CLI Command Results" on page 251"
CLI Error Checking and Error Messages
When you type CLI commands, the CLI checks these commands for correct
syntax. If you type 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=numlock
setting=on
Message:
BIOS setup configured successfully. Change will
take effect after the next reboot.
Command:
18 Introduction
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.
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.
Ty p e :
omconfig chassis volts index=3 minwarnthresh=3.300
When you type 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
Introduction 19
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 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
20 Introduction
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.
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:
Introduction 21
omconfig system assetinfo info=acquisition
purchasecost=
purchasedate=<mmddyy> ponum=
<n> waybill=<n> installdate=<mmddyy>
<n> signauth=<text>
expensed=<yes | no> costcenter=<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
2
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
3
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" on page 79.
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 Modular system
servermodule Modular system
mainsystem Modular system
system Non-modular system
chassis Non-modular system
preferences Modular/Non-modular
system
omreport: Viewing System Status Using the Instrumentation Service 27
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 Linux Enterprise Server and Red Hat Enterprise Linux
systems, omreport commands display external chassis information in a separate
section after the main chassis information. On Microsoft Windows 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.
Tab l e 3- 2 sho ws t he 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" on
page 27.
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 release
date.
biossetup A Shows BIOS setup
properties configured
during system boot.
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 the name and
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.
version of the
firmware.
front panel button
settings, such as the
Power button and/or
Nonmasking
Interrupt (NMI)
button (if present on
the system), are
enabled or disabled. It
also displays the front
panel security access
information and the
front panel LCD
information.
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...