Dell OpenManage Server Administrator Version 6.0.1 User Manual

Dell™ OpenManage™

Server Administrator Version 6.0.1

Command Line Interface

User's Guide

Notes, Cautions, and Warnings

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.

WARNING: A WARNING indicates a potential for property damage,

personal injury, or death.

____________________

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, Pow er Edg e, Po we rVau lt , and OpenManage are
trademarks of Dell Inc.; Microsoft, Windows, Active Directory, Hyper-V, 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.

November 2008

Contents

1 Introduction . . . . . . . . . . . . . . . . . . . . . . . 15

What's New for Version 6.0.1 . . . . . . . . . . . . . . 15

Using CLI Commands from Windows
Command Prompts

Primary CLI Commands . . . . . . . . . . . . . . . . . 17

. . . . . . . . . . . . . . . . . . . 17

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

Conventions for Parameter Tables . . . . . . . . . 28

Command Summary of the
omreport Command

Help With the omreport Command

. . . . . . . . . . . . . . . . . . . 28

27

. . . . . . . . . . . 32

Contents 3

omreport modularenclosure . . . . . . . . . . . . . . . 32

omreport about

. . . . . . . . . . . . . . . . . . . . . 34

omreport chassis/omreport
mainsystem Commands

. . . . . . . . . . . . . . . . . 35

omreport chassis/ omreport
mainsystem

. . . . . . . . . . . . . . . . . . . . . 35

omreport chassis acswitch/

omreport mainsystem acswitch . . . . . . . . . . 35

omreport chassis batteries/
omreport mainsystem batteries

. . . . . . . . . . 36

omreport chassis bios/

omreport mainsystem bios . . . . . . . . . . . . . 36

omreport chassis biossetup/

omreport mainsystem biossetup . . . . . . . . . . 37

omreport chassis bmc/
omreport mainsystem bmc

. . . . . . . . . . . . . 40

omreport chassis currents/

omreport mainsystem currents . . . . . . . . . . . 40

omreport chassis fans/omreport

mainsystem fans . . . . . . . . . . . . . . . . . . 40

omreport chassis fancontrol/
omreport mainsystem fancontrol

. . . . . . . . . . 40

omreport chassis firmware/omreport

mainsystem firmware . . . . . . . . . . . . . . . . 41

omreport chassis frontpanel/omreport

mainsystem frontpanel . . . . . . . . . . . . . . . 41

omreport chassis fru/omreport
mainsystem fru

. . . . . . . . . . . . . . . . . . . 41

omreport chassis hwperformance/
omreport mainsystem hwperformance

. . . . . . 42

omreport chassis info/omreport

mainsystem info . . . . . . . . . . . . . . . . . . 42

omreport chassis intrusion

. . . . . . . . . . . . . 43

omreport chassis leds/omreport

mainsystem leds . . . . . . . . . . . . . . . . . . 44

4 Contents

omreport chassis memory/omreport

mainsystem memory . . . . . . . . . . . . . . . . 44

omreport chassis nics/omreport

mainsystem nics . . . . . . . . . . . . . . . . . . 46

omreport chassis ports/omreport

mainsystem ports . . . . . . . . . . . . . . . . . . 46

omreport chassis processors/omreport
mainsystem processors

. . . . . . . . . . . . . . 47

omreport chassis pwrmanagement/

omreport mainsystem pwrmanagement . . . . . . 50

omreport chassis pwrmonitoring/

omreport mainsystem pwrmonitoring . . . . . . . 51

omreport chassis pwrsupplies/
omreport mainsystem pwrsupplies

. . . . . . . . 53

omreport chassis remoteaccess/

omreport mainsystem remoteaccess . . . . . . . 54

omreport chassis slots/omreport

mainsystem slots . . . . . . . . . . . . . . . . . . 55

omreport chassis temps/omreport
mainsystem temps

. . . . . . . . . . . . . . . . . 55

omreport chassis volts/omreport

mainsystem volts . . . . . . . . . . . . . . . . . . 56

omreport system Commands/omreport
servermodule Commands

. . . . . . . . . . . . . . . . 56

omreport system/omreport
servermodule

Commands for Viewing Logs

. . . . . . . . . . . . . . . . . . . . 56

. . . . . . . . . . . . 57

omreport system alertaction/omreport
servermodule alertaction

. . . . . . . . . . . . . 58

omreport system assetinfo/omreport
servermodule assetinfo

. . . . . . . . . . . . . . 60

omreport system events/omreport

servermodule events . . . . . . . . . . . . . . . . 60

omreport system operatingsystem/
omreport servermodule operatingsystem

. . . . . 62

Contents 5

omreport system pedestinations/

omreport servermodule pedestinations . . . . . . 62

omreport system platformevents/

omreport servermodule platformevents . . . . . . 64

omreport system recovery/omreport

servermodule recovery . . . . . . . . . . . . . . . 64

omreport system shutdown/omreport
servermodule shutdown

. . . . . . . . . . . . . . 64

omreport system summary/omreport

servermodule summary . . . . . . . . . . . . . . 64

omreport system thrmshutdown/

omreport servermodule thrmshutdown . . . . . . 68

omreport system version/omreport
servermodule version

. . . . . . . . . . . . . . . 68

4 omconfig: Managing

Components Using the
Instrumentation Service 71

Conventions for Parameter Tables . . . . . . . . . 72

6 Contents

omconfig Command Summary

Help With the omconfig Command

omconfig about

. . . . . . . . . . . . . . . . . . . . . 78

omconfig chassis/omconfig mainsystem

. . . . . . . . . . . . . . 72

. . . . . . . . . . . 77

. . . . . . . . 79

omconfig chassis biossetup/omconfig
mainsystem biossetup

. . . . . . . . . . . . . . . 79

omconfig chassis bmc/omconfig
mainsystem bmc

. . . . . . . . . . . . . . . . . . 88

omconfig chassis currents/omconfig

mainsystem currents . . . . . . . . . . . . . . . . 88

omconfig chassis fans/omconfig
mainsystem fans

. . . . . . . . . . . . . . . . . . 88

omconfig chassis fancontrol/omconfig

mainsystem fancontrol . . . . . . . . . . . . . . . 89

omconfig chassis frontpanel/omconfig

mainsystem frontpanel . . . . . . . . . . . . . . . 90

omconfig chassis info/omconfig

mainsystem info . . . . . . . . . . . . . . . . . . 91

omconfig chassis leds/omconfig

mainsystem leds . . . . . . . . . . . . . . . . . . 92

omconfig chassis memorymode/
omconfig mainsystem memorymode

. . . . . . . . 93

omconfig chassis pwrmanagement/

omconfig mainsystem pwrmanagement . . . . . . 94

omconfig chassis pwrmonitoring/

omconfig mainsystem pwrmonitoring . . . . . . . 96

omconfig chassis remoteaccess/
omconfig mainsystem remoteaccess

. . . . . . . 97

omconfig chassis temps/omconfig

mainsystem temps . . . . . . . . . . . . . . . . . 108

omconfig chassis volts/omconfig

mainsystem volts . . . . . . . . . . . . . . . . . . 109

omconfig preferences . . . . . . . . . . . . . . . . . . 111

omconfig preferences cdvformat

. . . . . . . . . 111

omconfig preferences dirservice . . . . . . . . . 111

omconfig preferences snmp

omconfig preferences useraccess

. . . . . . . . . . . . 112

. . . . . . . . 114

omconfig system/omconfig servermodule

. . . . . . . 114

omconfig system alertaction/omconfig
servermodule alertaction

Commands for Clearing Logs

. . . . . . . . . . . . . 114

. . . . . . . . . . . 118

omconfig system pedestinations/
omconfig servermodule pedestinations

. . . . . . 119

omconfig system platformevents/
omconfig servermodule platformevents

. . . . . . 120

omconfig system events/omconfig

servermodule events . . . . . . . . . . . . . . . . 122

omconfig system webserver/omconfig
servermodule webserver

. . . . . . . . . . . . . 125

Contents 7

omconfig system recovery/omconfig

servermodule recovery . . . . . . . . . . . . . . . 125

omconfig system shutdown/omconfig

servermodule shutdown . . . . . . . . . . . . . . 126

omconfig system thrmshutdown/

omconfig servermodule thrmshutdown . . . . . . 127

5 omconfig system or servermodule

assetinfo: Editing Cost of
Ownership Values 129

Overview . . . . . . . . . . . . . . . . . . . . . . . . . 129

User Level Required for Adding
Asset Information

. . . . . . . . . . . . . . . . . 129

8 Contents

Adding Acquisition Information

. . . . . . . . . . . . . 130

Example Commands for Adding
Acquisition Information

Adding Depreciation Information

. . . . . . . . . . . . . . 131

. . . . . . . . . . . . 132

Example Commands for Adding
Depreciation Information

. . . . . . . . . . . . . . 132

Adding Extended Warranty Information

Example Command for Adding Extended
Warranty Information

Adding Lease Information

. . . . . . . . . . . . . . . 134

. . . . . . . . . . . . . . . . 134

Example Command for Adding
Lease Information

Adding Maintenance Information

. . . . . . . . . . . . . . . . . 135

. . . . . . . . . . . . 136

Example Command for Adding
Maintenance Information

. . . . . . . . . . . . . 136

. . . . . . . . 133

Adding Outsource Information . . . . . . . . . . . . . 137

Example Command for Adding
Outsource Information

. . . . . . . . . . . . . . . 137

Adding Owner Information

. . . . . . . . . . . . . . . 138

Example Command for Adding
Owner Information

Adding Service Contract Information

. . . . . . . . . . . . . . . . . 139

. . . . . . . . . . 139

Example Command for Adding
Service Information

Adding Support Information

. . . . . . . . . . . . . . . . 140

. . . . . . . . . . . . . . . 141

Example Command for Adding
Support Information

Adding System Information

. . . . . . . . . . . . . . . . 142

. . . . . . . . . . . . . . . 142

Example Command for Adding
System Information

Adding Warranty Information

. . . . . . . . . . . . . . . . . 143

. . . . . . . . . . . . . . 144

Example Command for Adding
Warranty Information

. . . . . . . . . . . . . . . 144

6 Using the Storage

Management Service 147

CLI Command Syntax . . . . . . . . . . . . . . . . . . 147

Syntax for Required, Optional, and
Variable Command Elements

. . . . . . . . . . . . . . 148

User Privileges for omreport storage
and omconfig storage

omreport Command

. . . . . . . . . . . . . . . . . . 150

. . . . . . . . . . . . . . . . . . . 150

Contents 9

omreport Storage Help . . . . . . . . . . . . . . . . . 151

omreport Controller Status

. . . . . . . . . . . . . 151

omreport Global Information

(Smart Thermal Shutdown Status) . . . . . . . . . 152

omreport Battery Status

omreport Connector Status

. . . . . . . . . . . . . . 152

. . . . . . . . . . . . 153

omreport Enclosure Status . . . . . . . . . . . . . 153

omreport Temperature Probe Status

omreport Fan Status

. . . . . . . . . . . . . . . . 155

. . . . . . . . 154

omreport Power Supply Status . . . . . . . . . . . 156

omreport EMM Status

omreport Physical Disk Status

. . . . . . . . . . . . . . . 157

. . . . . . . . . . . 158

omreport Virtual Disk Status . . . . . . . . . . . . 159

omconfig Global Commands . . . . . . . . . . . . . . 159

omconfig Global Enable Smart
Thermal Shutdown

. . . . . . . . . . . . . . . . . 159

omconfig Global Disable Smart
Thermal Shutdown

. . . . . . . . . . . . . . . . . 160

omconfig Global Rescan Controller . . . . . . . . 161

omconfig Controller Commands . . . . . . . . . . . . . 161

omconfig Rescan Controller

. . . . . . . . . . . . 163

omconfig Enable Controller Alarm . . . . . . . . . 164

omconfig Disable Controller Alarm

omconfig Quiet Controller Alarm

omconfig Test Controller Alarm

omconfig Reset Controller Configuration

omconfig Create Virtual Disk

omconfig Set Controller Rebuild Rate

. . . . . . . . 164

. . . . . . . . . . 165

. . . . . . . . . . 165

. . . . . 166

. . . . . . . . . . . . 166

. . . . . . . 172

omconfig Set Background
Initialization Rate

. . . . . . . . . . . . . . . . . . 173

omconfig Set Reconstruct Rate . . . . . . . . . . 173

omconfig Set Check Consistency Rate

omconfig Export the Controller Log

. . . . . . . 174

. . . . . . . . 174

10 Contents

omconfig Import Foreign Configuration . . . . . . 175

omconfig Import/Recover Foreign

Configuration . . . . . . . . . . . . . . . . . . . . 175

omconfig Clear Foreign Configuration

omconfig Set Patrol Read Mode

. . . . . . . 176

. . . . . . . . . . 176

omconfig Start Patrol Read . . . . . . . . . . . . 177

omconfig Stop Patrol Read

omconfig Change Controller Properties

. . . . . . . . . . . . 177

. . . . . . 178

omconfig Storage Virtual Disk . . . . . . . . . . . 178

omconfig Storage Controller

. . . . . . . . . . . . 179

omconfig Virtual Disk Commands

omconfig Blink Virtual Disk

omconfig Unblink Virtual Disk

omconfig Initialize Virtual Disk

. . . . . . . . . . . 180

. . . . . . . . . . . . 181

. . . . . . . . . . . 181

. . . . . . . . . . . 182

omconfig Cancel Initialize Virtual Disk . . . . . . . 182

omconfig Fast Initialize Virtual Disk

omconfig Slow Initialize Virtualize Disk

. . . . . . . . 183

. . . . . . 183

omconfig Cancel Background Initialize . . . . . . 184

omconfig Restore Dead Segments

omconfig Split Mirror

. . . . . . . . . . . . . . . 185

. . . . . . . . 184

omconfig Unmirror . . . . . . . . . . . . . . . . . 185

omconfig Assign Dedicated Hot Spare

omconfig Unassign Dedicated Hot Spare

omconfig Check Consistency

. . . . . . . . . . . 188

omconfig Cancel Check Consistency

omconfig Pause Check Consistency

omconfig Resume Check Consistency

omconfig Delete Virtual Disk

omconfig Format Virtual Disk

. . . . . . . . . . . . 190

. . . . . . . . . . . 191

. . . . . . 186

. . . . . 187

. . . . . . . 189

. . . . . . . . 189

. . . . . . . 190

omconfig Reconfiguring Virtual Disks . . . . . . . 191

omconfig Change Virtual Disk Policy

omconfig Rename Virtual Disk

. . . . . . . 192

. . . . . . . . . . . 193

Contents 11

omconfig Physical Disk Commands . . . . . . . . . . . 193

omconfig Blink Physical Disk

omconfig Unblink Physical Disk

. . . . . . . . . . . . 194

. . . . . . . . . . 195

omconfig Prepare to Remove Physical Disk . . . . 196

omconfig Initialize Physical Disk

omconfig Offline Physical Disk

. . . . . . . . . . 197

. . . . . . . . . . . 198

omconfig Offline Physical Disk . . . . . . . . . . . 198

omconfig Online Physical Disk

omconfig Assign Global Hot Spare

. . . . . . . . . . . 199

. . . . . . . . . 200

omconfig Unassign Global Hot Spare . . . . . . . 201

omconfig Rebuild Physical Disk

omconfig Cancel Rebuild Physical Disk

. . . . . . . . . . 202

. . . . . . 203

omconfig Remove Dead Segments . . . . . . . . 204

omconfig Clear Physical Disk

omconfig Cancel Clear Physical Disk

. . . . . . . . . . . 205

. . . . . . . 205

omconfig Cancel Replace Member . . . . . . . . 206

omconfig Battery Commands . . . . . . . . . . . . . . 206

omconfig Recondition Battery

. . . . . . . . . . . 207

omconfig Start Battery Learn Cycle . . . . . . . . 207

omconfig Delay Battery Learn Cycle

. . . . . . . . 208

12 Contents

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

. . . . . . . . . . . . 208

. . . . . . . . . . . . 208

. . . . . . . . . . . . . 210

. . . . . . . . . 210

. . . . . . . . 211

. . . . . . . . . 212

. . . . . . . 212

omconfig Set Temperature Probe

Thresholds . . . . . . . . . . . . . . . . . . . . . 213

omconfig Reset Temperature Probe

Thresholds . . . . . . . . . . . . . . . . . . . . . 214

omconfig Set All Temperature Probe

Thresholds . . . . . . . . . . . . . . . . . . . . . 214

omconfig Reset All Temperature Probe

Thresholds . . . . . . . . . . . . . . . . . . . . . 215

omconfig Blink

. . . . . . . . . . . . . . . . . . . 216

7 Working With CLI

Command Results 217

Output Options for Command Results . . . . . . . 217

Controlling Command Output Display

Writing Command Output to a File . . . . . . . . . 218

Selecting a Format for Your CLI
Command Output

. . . . . . . . . . . . . . . . . . 220

. . . . . . . 217

Glossary 225

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

Contents 13

14 Contents

1

Introduction

You can perform essential systems management tasks using Dell™
OpenManage
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 125" for more information.

™ Server Administrator’s graphical user interface (GUI) or the

revolutions per minute (

RPM), memory

What's New for Version 6.0.1

The following features are new in this release of Server Administrator:

• Support for three new

• Support for the following system components:

• 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

• Display of the CPU turbo mode

xx1x

systems.

xx1x

systems

Introduction 15

• 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, and 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

• Inclusion of Internet Protocol version 6:

• This release supports IPv6, in addition to IPv4.

16 Introduction

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.

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.

Introduction 17

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 for more information on corresponding CLI syntax.

Section Title Related Sections

"omconfig system or servermodule

Using the Instrumentation Service"

Using the Instrumentation Service"

assetinfo: Editing Cost of Ownership
Va lu e s"

Additional useful topics about the CLI include:

• "Working With CLI Command Results"

• "Glossary"

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

18 Introduction

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.

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.

Introduction 19

Ty p e :

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

20 Introduction

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.

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.

Introduction 21

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

•shutdown

Using the omhelp Command 23

• 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."

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

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
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 le 3 -2 s ho ws 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."

®

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

modularen
closure

about U, P, A Shows version number and properties for

chassis/mai
nsystem

Command
Level 3

details=true U, P, A Displays information for all the Server

acswitch U, P, A Shows failover settings where redundant

batteries U, P, A Shows the properties set for batteries.

bios U, P, A Shows BIOS information such as

biossetup A Shows BIOS setup properties configured

fancontrol U, P, A Shows the properties set for fan speed.

fans U, P, A Shows the status and thresholds for

firmware U, P, A Shows firmware properties such as

frontpanel U, P, A Shows whether the front panel button

fru U, P, A Shows the Field Replaceable Unit (FRU)

hwperformance U, P, A Shows the status and cause for the

User
Privilege
Required

U, P, A Shows information for all the modular

U, P, A Shows the general status of all the main

Use

chassis.

Server Administrator.

Administrator programs installed.

components.

AC power lines are supported in a system.

manufacturer, version, and date last
updated.

during system boot.

system fans.

version, date of last update, and whether
the firmware is updatable.

settings, such as the Powe r button and/or
Nonmasking Interrupt (NMI) button
(if present on the system), are enabled or
disabled.

information.

system’s performance degradation.

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

info U, P, A Shows a status summary for main system

intrusion U, P, A Shows the status of the system’s

leds U, P, A Shows the properties you have set for

memory U, P, A Shows properties of your system's

nics U, P, A Shows the number of NICs installed in

ports U, P, A Shows the properties for your system’s

processors U, P, A Shows properties of your system’s

pwrmanagement U, P, A Shows power management profiles that

pwrmonitoring U, P, A Shows properties of power consumption.

pwrsupplies U, P, A Shows properties of power supplies.

remoteaccess U, P, A Shows general information on remote

slots U, P, A Shows properties of your system’s

temps U, P, A Shows the status and thresholds for the

volts U, P, A Shows the status and thresholds for the

User
Privilege
Required

Use

chassis components.

intrusion sensor(s).

light-emitting diodes to flash under
various alert conditions.

memory arrays.

your system and displays controller and
interface related details.

parallel and serial ports, such as I/O
address, IRQ level, connector type, and
maximum speed.

processors, including speed,
manufacturer, and processor family.

will provide control over power
utilization.

access.

expansion slots and other slot types.

system temperature sensors.

system voltage sensors.

30 omreport: Viewing System Status Using the Instrumentation Service