Dell OpenManage Server Administrator Version 7.0 Command Line Interface Guide

Dell OpenManage

Server Administrator

Version 7.0

Command Line

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

____________________

Reproduction of these materials in any manner whatsoever without the written permission of Dell Inc. is strictly forbidden.

Trademarks used in this text: Dell™, PowerEdge™, and OpenManage™ are trademarks of Dell Inc. Microsoft 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 Hat Enterprise Linux countries. Intel Intel Corporation in the United States and other countries. AMD AMD PowerNow!™ are trademarks of Advanced Micro Devices Inc. VMware trademark and ESX Server™ is a trademark of VMware Inc in the United States and/or other jurisdictions. Citrix Systems, Inc. in the United States and/or other countries.

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 itsown.

, Windows®, Active Directory®, MS-DOS®, and Windows Server® are either trademarks

are registered trademarks of Red Hat, Inc. in the United States and other

, Pentium®, and Itanium® are registered trademarks and Intel386™ is a trademark of

, Xen®, XenServer® and XenMotion® are either registered trademarks or trademarks of Citrix

, AMD Opteron™, AMD-V™, and

is a registered

and Red

2012 - 03

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

Overview . . . . . . . . . . . . . . . . . . . . . . . . 15

What's New in Version 7.0

Systems, Operating Systems, and Browsers Support

New Features

Using CLI Commands From Windows Command Prompts

Primary CLI Commands

CLI Error Checking and Error Messages

Success Messages

Failure Messages

Scripting and Comparing With the CLI

Command Syntax Overview

. . . . . . . . . . . . . . . 16

. . . . . . . . . . . . . . . . . 16

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

. . . . . . . . . . . . . . . . . . . 18

. . . . . . . . . . . . . . . . . 19

. . . . . . . . 20

. . . . . . . . . . . . . . . . 20

. . . . . . . . . . . . . . . . . 21

. . . . . . . . . 22

. . . . . . . . . . . . . . . 23

2 Using the omhelp Command . . . . . . . . . . 25

Example Help Commands . . . . . . . . . . . . . . . . 25

3 omreport: Viewing System Status

Using the Instrumentation Service

. . . . . . . . . . . . . . . . . . . . . . . . . . 29

Conventions for Parameter Tables . . . . . . . . . 30

Contents 3

Command Summary of the omreport Command . . . . . 30

Help With the omreport Command

omreport modularenclosure

. . . . . . . . . . . 37

. . . . . . . . . . . . . . . 37

omreport about . . . . . . . . . . . . . . . . . . . . . 38

omreport chassis or omreport mainsystem Commands

. . . . . . . . . . . . . . . . . . . . . . . . 39

omreport chassis or omreport mainsystem

. . . . 39

omreport chassis acswitch or omreport

mainsystem acswitch . . . . . . . . . . . . . . . 40

omreport chassis batteries or omreport

mainsystem batteries . . . . . . . . . . . . . . . . 41

omreport chassis bios or omreport mainsystem bios

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

omreport chassis biossetup or omreport

mainsystem biossetup . . . . . . . . . . . . . . . 42

omreport chassis currents or omreport

mainsystem currents

. . . . . . . . . . . . . . . . 46

omreport chassis removableflashmedia or omreport mainsystem removableflashmedia . . . 47

omreport chassis fans or omreport mainsystem fans

. . . . . . . . . . . . . . . . . . 48

omreport chassis firmware or omreport mainsystem firmware

. . . . . . . . . . . . . . . . 48

omreport chassis frontpanel or omreport

mainsystem frontpanel . . . . . . . . . . . . . . . 49

omreport chassis fru or omreport mainsystem fru

. . . . . . . . . . . . . . . . . . . 49

omreport chassis hwperformance or

omreport mainsystem hwperformance . . . . . . 50

omreport chassis info or omreport

mainsystem info . . . . . . . . . . . . . . . . . . 50

omreport chassis intrusion

. . . . . . . . . . . . . 51

omreport chassis leds or omreport

mainsystem leds . . . . . . . . . . . . . . . . . . 52

4 Contents

omreport chassis memory or omreport mainsystem memory

. . . . . . . . . . . . . . . . 52

omreport chassis nics or omreport mainsystem nics

. . . . . . . . . . . . . . . . . . 54

omreport chassis ports or omreport

mainsystem ports . . . . . . . . . . . . . . . . . . 55

omreport chassis processors or omreport

mainsystem processors . . . . . . . . . . . . . . 56

omreport chassis pwrmanagement or omreport mainsystem pwrmanagement

. . . . . . 59

omreport chassis pwrmonitoring or

omreport mainsystem pwrmonitoring . . . . . . . 60

omreport chassis pwrsupplies or omreport

mainsystem pwrsupplies . . . . . . . . . . . . . . 63

omreport chassis remoteaccess or omreport mainsystem remoteaccess

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

omreport chassis slots or omreport

mainsystem slots . . . . . . . . . . . . . . . . . . 65

omreport chassis temps or omreport

mainsystem temps . . . . . . . . . . . . . . . . . 66

omreport chassis volts or omreport

mainsystem volts . . . . . . . . . . . . . . . . . . 66

omreport system Commands or omreport servermodule Commands

. . . . . . . . . . . . . . . . 66

omreport system or omreport servermodule

Commands for Viewing Logs

. . . . . . . . . . . . 67

omreport system alertaction or omreport

servermodule alertaction . . . . . . . . . . . . . 68

omreport system assetinfo or omreport servermodule assetinfo

. . . . . . . . . . . . . . 70

omreport system events or omreport

servermodule events . . . . . . . . . . . . . . . . 71

omreport system operatingsystem or

omreport servermodule operatingsystem . . . . . 74

omreport system pedestinations or omreport servermodule pedestinations

. . . . . . . . . . . 74

. . . 67

Contents 5

omreport system platformevents or omreport servermodule platformevents

. . . . . . . . . . . 76

omreport system recovery or omreport servermodule recovery

. . . . . . . . . . . . . . . 76

omreport system shutdown or omreport

servermodule shutdown . . . . . . . . . . . . . . 77

omreport system summary or omreport

servermodule summary . . . . . . . . . . . . . . 77

omreport system thrmshutdown or omreport servermodule thrmshutdown

. . . . . . . . . . . . 84

omreport system version or omreport

servermodule version . . . . . . . . . . . . . . . 85

omreport preferences Commands

. . . . . . . . . . . . 86

4 omconfig: Managing Components

Using the Instrumentation

Service . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Conventions for Parameter Tables . . . . . . . . . 88

omconfig Command Summary

Help With the omconfig Command . . . . . . . . . . . 93

omconfig about

. . . . . . . . . . . . . . . . . . . . . 94

omconfig chassis or omconfig mainsystem

omconfig chassis biossetup or omconfig mainsystem biossetup

omconfig chassis currents or omconfig

mainsystem currents . . . . . . . . . . . . . . . . 120

omconfig chassis fans or omconfig mainsystem fans

omconfig chassis frontpanel or omconfig mainsystem frontpanel

omconfig chassis info or omconfig

mainsystem info . . . . . . . . . . . . . . . . . . 123

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

. . . . . . . 96

. . . . . . . . . . . . . . . 96

. . . . . . . . . . . . . . . . . . 120

. . . . . . . . . . . . . . . 121

6 Contents

omconfig chassis leds or omconfig mainsystem leds

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

omconfig chassis memorymode or omconfig mainsystem memorymode

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

omconfig chassis pwrmanagement or

omconfig mainsystem pwrmanagement . . . . . . 127

omconfig chassis pwrmonitoring or

omconfig mainsystem pwrmonitoring . . . . . . . 129

omconfig chassis remoteaccess or omconfig mainsystem remoteaccess

. . . . . . . 131

omconfig chassis temps or omconfig

mainsystem temps . . . . . . . . . . . . . . . . . 145

omconfig chassis volts or omconfig

mainsystem volts . . . . . . . . . . . . . . . . . . 146

omconfig preferences . . . . . . . . . . . . . . . . . . 148

omconfig preferences cdvformat

. . . . . . . . . 148

omconfig preferences dirservice . . . . . . . . . 149

omconfig preferences snmp

omconfig preferences useraccess

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

. . . . . . . . 151

omconfig preferences webserver . . . . . . . . . 152

omconfig system or omconfig servermodule

. . . . . . 153

omconfig system alertaction or omconfig

servermodule alertaction . . . . . . . . . . . . . 153

Commands for Clearing Logs

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

omconfig system pedestinations or

omconfig servermodule pedestinations . . . . . . 159

omconfig system platformevents or

omconfig servermodule platformevents . . . . . . 159

omconfig system events or omconfig servermodule events

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

omconfig system webserver or omconfig servermodule webserver

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

omconfig system recovery or omconfig

servermodule recovery . . . . . . . . . . . . . . 166

Contents 7

omconfig system shutdown or omconfig servermodule shutdown

. . . . . . . . . . . . . . 167

omconfig system thrmshutdown or omconfig servermodule thrmshutdown

. . . . . . . . . . . . 168

5 omconfig system or servermodule

assetinfo: Editing Cost of

Ownership Values . . . . . . . . . . . . . . . . . 171

User Level Required for Adding Asset Information

Adding Acquisition Information . . . . . . . . . . . . . 171

Example Commands for Adding Acquisition Information

Adding Depreciation Information . . . . . . . . . . . . 174

Example Commands for Adding Depreciation Information

Adding Extended Warranty Information . . . . . . . . 175

Example Command for Adding Extended Warranty Information

. . . . . . . . . . . . . . . . . 171

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

. . . . . . . . . . . . . . . . . . . . . 174

. . . . . . . . . . . . . . . 176

8 Contents

Adding Lease Information

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

Example Command for Adding Lease Information

Adding Maintenance Information

. . . . . . . . . . . . . . . . . . . . . 178

. . . . . . . . . . . . 178

Example Command for Adding Maintenance Information

Adding Outsource Information

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

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

Example Command for Adding Outsource Information

Adding Owner Information

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

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

Example Command for Adding Owner Information

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

Adding Service Contract Information . . . . . . . . . . 183

Example Command for Adding Service Information

. . . . . . . . . . . . . . . . . . . . . 184

Adding Support Information . . . . . . . . . . . . . . . 184

Example Command for Adding Support Information

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

Adding System Information . . . . . . . . . . . . . . . 186

Example Command for Adding System

Information

. . . . . . . . . . . . . . . . . . . . . 187

Adding Warranty Information . . . . . . . . . . . . . . 187

Example Command for Adding Warranty Information

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

6 Using the Storage Management

Service . . . . . . . . . . . . . . . . . . . . . . . . . 191

CLI Command Syntax . . . . . . . . . . . . . . . . . . 191

Syntax for Required, Optional, and Variable Command Elements

. . . . . . . . . . . . . . . . . . . 192

User Privileges for omreport storage and omconfig storage

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

7 omreport storage Commands . . . . . . . . 195

omreport Physical Disk Status . . . . . . . . . . . . . 196

omreport Virtual Disk Status

omreport Controller Status

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

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

Contents 9

omreport Enclosure Status . . . . . . . . . . . . . . . 200

omreport Temperature Probe Status

. . . . . . . . 201

omreport Fan Status . . . . . . . . . . . . . . . . 202

omreport Power Supply Status

omreport EMM Status

. . . . . . . . . . . . . . . 204

. . . . . . . . . . . 203

omreport Enclosure Slot Occupancy Report . . . . 205

omreport Battery Status . . . . . . . . . . . . . . . . . 205

omreport Global Information (Smart Thermal Shutdown Status, Hot Spare Protection Policy)

. . . . 206

omreport Connector Status

omreport Cachecade Status

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

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

8 omconfig storage Commands . . . . . . . . 209

omconfig Physical Disk Commands . . . . . . . . . . . 210

omconfig Blink Physical Disk

omconfig Unblink Physical Disk . . . . . . . . . . 212

omconfig Prepare to Remove Physical Disk

omconfig Instant Erase Secured

Physical Disk . . . . . . . . . . . . . . . . . . . . 214

omconfig Initialize Physical Disk

omconfig Offline Physical Disk

omconfig Online Physical Disk

omconfig Assign Global Hot Spare

omconfig Rebuild Physical Disk . . . . . . . . . . 217

omconfig Cancel Rebuild Physical Disk

omconfig Cancel Replace Member

omconfig Clear Physical Disk

omconfig Cancel Clear Physical Disk

omconfig Enable Device Write Cache

omconfig Disable Device Write Cache

. . . . . . . . . . . . 211

. . . . 213

. . . . . . . . . . 214

. . . . . . . . . . . 215

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

. . . . . . . . . 216

. . . . . . 218

. . . . . . . . 219

. . . . . . . . . . . 219

. . . . . . . 220

. . . . . . . 221

10 Contents

omconfig Export Reliability Log . . . . . . . . . . 222

omconfig Convert RAID to Non-RAID . . . . . . . 223

omconfig Convert Non-RAID to RAID

. . . . . . . 224

omconfig Virtual Disk Commands

omconfig Check Consistency

omconfig Cancel Check Consistency

omconfig Pause Check Consistency

. . . . . . . . . . . 224

. . . . . . . . . . . 226

. . . . . . . 226

. . . . . . . . 227

omconfig Resume Check Consistency . . . . . . . 227

omconfig Blink Virtual Disk

omconfig Unblink Virtual Disk

. . . . . . . . . . . . 228

. . . . . . . . . . . 228

omconfig Initialize Virtual Disk . . . . . . . . . . . 229

omconfig Fast Initialize Virtual Disk

omconfig Slow Initialize Virtualize Disk

. . . . . . . . 229

. . . . . . 230

omconfig Cancel Initialize Virtual Disk . . . . . . . 231

omconfig Cancel Background Initialize

omconfig Assign Dedicated Hot Spare

. . . . . . 231

. . . . . . 232

omconfig Delete Virtual Disk . . . . . . . . . . . . 233

omconfig Format Virtual Disk

. . . . . . . . . . . 233

omconfig Reconfiguring Virtual Disks . . . . . . . 234

omconfig Secure Virtual Disk

omconfig Clear Virtual Disk Bad Blocks

. . . . . . . . . . . 235

. . . . . . 236

omconfig Change Virtual Disk Policy . . . . . . . 236

omconfig Replace Member Virtual Disk

omconfig Rename Virtual Disk

. . . . . . . . . . . 238

. . . . . . 237

omconfig Controller Commands

omconfig Rescan Controller

omconfig Enable Controller Alarm

. . . . . . . . . . . . 239

. . . . . . . . . . . . 241

. . . . . . . . . 242

omconfig Disable Controller Alarm . . . . . . . . 242

omconfig Quiet Controller Alarm

omconfig Test Controller Alarm

omconfig Reset Controller Configuration

omconfig Create Virtual Disk

. . . . . . . . . . 243

. . . . . 244

. . . . . . . . . . . . 244

Contents 11

omconfig Set Controller Rebuild Rate . . . . . . . 251

omconfig Change Controller Properties . . . . . . 252

omconfig Discard Preserved Cache

omconfig Create Encryption Key

. . . . . . . . 253

. . . . . . . . . . 253

omconfig Change Encryption Key . . . . . . . . . 254

omconfig Delete Encryption Key

. . . . . . . . . . 254

omconfig Set Background Initialization

Rate . . . . . . . . . . . . . . . . . . . . . . . . . 255

omconfig Set Reconstruct Rate

omconfig Set Check Consistency Rate

. . . . . . . . . . 255

. . . . . . . 256

omconfig Export the Controller Log . . . . . . . . 256

omconfig Import Secure Foreign Configuration

. . . . . . . . . . . . . . . . . . . . 257

omconfig Import Foreign Configuration . . . . . . 257

omconfig Import or Recover Foreign Configuration

. . . . . . . . . . . . . . . . . . . . 258

omconfig Clear Foreign Configuration . . . . . . . 258

omconfig Physical Disk Power Management

omconfig Set Patrol Read Mode

. . . . . . . . . . 260

. . . 259

omconfig Start Patrol Read . . . . . . . . . . . . 260

omconfig Stop Patrol Read

. . . . . . . . . . . . . 261

omconfig Create Cachecade . . . . . . . . . . . . 261

omconfig Enable LKM Controller

omconfig Rekey LKM Controller

. . . . . . . . . . 262

omconfig Convert Multiple RAID to Non-RAID

. . . . . . . . . . . . . . . . . 263

omconfig Convert Multiple

Non-RAID to RAID . . . . . . . . . . . . . . . . . 263

12 Contents

Omconfig Enclosure Commands

omconfig Enable Enclosure Alarm

omconfig Disable Enclosure Alarm

omconfig Set Enclosure Asset Tag

omconfig Set Enclosure Asset Name

. . . . . . . . . . . . 264

. . . . . . . . . 265

. . . . . . . . 265

. . . . . . . . . 266

. . . . . . . 267

omconfig Set Temperature Probe Thresholds

. . . . . . . . . . . . . . . . . . . . . 267

omconfig Reset Temperature Probe Thresholds

. . . . . . . . . . . . . . . . . . . . . 268

omconfig Set All Temperature Probe

Thresholds . . . . . . . . . . . . . . . . . . . . . 269

omconfig Reset All Temperature Probe

Thresholds . . . . . . . . . . . . . . . . . . . . . 270

omconfig Blink

. . . . . . . . . . . . . . . . . . . 270

omconfig Battery Commands

omconfig Start Battery Learn Cycle

omconfig Delay Battery Learn Cycle

omconfig Global Commands

. . . . . . . . . . . . . . 271

. . . . . . . . 271

. . . . . . . . 272

. . . . . . . . . . . . . . 272

omconfig Global Enable Smart Thermal Shutdown

. . . . . . . . . . . . . . . . . . . . . 273

omconfig Global Disable Smart Thermal

Shutdown . . . . . . . . . . . . . . . . . . . . . 274

omconfig Global Rescan Controller

omconfig Set Hot Spare Protection Policy

omconfig Connector Commands

omconfig Rescan Connector

omconfig Cachecade Commands

omconfig Blink Cachecade

omconfig Unblink Cachecade

. . . . . . . . 275

. . . . 275

. . . . . . . . . . . . 276

. . . . . . . . . . . . 277

. . . . . . . . . . . 278

omconfig Delete Cachecade . . . . . . . . . . . . 278

omconfig Resize Cachecade

omconfig Rename Cachecade

. . . . . . . . . . . . 279

. . . . . . . . . . . 280

9 Working With CLI Command

Results . . . . . . . . . . . . . . . . . . . . . . . . . 281

Output Options for Command Results . . . . . . . . . . 281

Contents 13

Controlling Command Output Display . . . . . . . . . . 281

Writing Command Output to a File

. . . . . . . . . . . 282

Saving Command Results to a File That is Overwritten

. . . . . . . . . . . . . . . . . . . . . 282

Append Command Results to an Existing File . . . 283

Selecting a Format for the CLI Command Output . . . . 284

List (lst)

. . . . . . . . . . . . . . . . . . . . . . . 285

Table (tbl) . . . . . . . . . . . . . . . . . . . . . . 286

Semicolon-separated Values (ssv)

Custom Delimited Format (cdv)

. . . . . . . . . 286

. . . . . . . . . . . 287

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

14 Contents

Introduction

Overview

Dell OpenManage Server Administrator (OMSA) provides a comprehensive, one-to-one systems management solution in two ways: from an integrated, Web browser-based graphical user interface (GUI) and from a command line interface (CLI) through the operating system. Server Administrator is designed for system administrators to manage systems locally and remotely on a network. It allows system administrators to focus on managing their entire network by providing comprehensive one-to-one systems management.

In the context of Server Administrator, a system refers to a stand-alone system, a system with attached network storage units in a separate chassis, or a Blade system consisting of one or more server modules in a modular enclosure.

Server Administrator provides easy-to-use management and administration of local and remote systems through a comprehensive set of integrated management services. Server Administrator is the sole installation on the system being managed and is accessible both locally and remotely from the Server Administrator home page. Access remotely monitored systems by dialin, LAN, or wireless connections.

Configuration features allow Server Administrator to perform essential tasks described in detail in the following sections. This CLI guide documents all the commands that apply to Server Administrator and Storage Management.

Introduction 15

The reporting and viewing features allow retrieval of overall health status for systems on the network. At the component level, view information about voltage, temperature, fan’s

revolutions per minute (

RPM), memory functioning, and many other critical component details. See a detailed account of cost of ownership (COO) facts about the system in a summary view. Retrieve version information for BIOS, firmware, operating system, and all installed software.

NOTE: Use the CLI instead of the Server Administrator home page, and turn the

Server Administrator Web server off for concerns on encryption. 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 issue this command each time a system starts up. See "omconfig system webserver or omconfig servermodule webserver" on page 166 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.

NOTE: For information on terms used in this document, see the Glossary at

support.dell.com.

What's New in Version 7.0

The release highlights of OpenManage Server Administrator 7.0:

Systems, Operating Systems, and Browsers Support

Added support for the following:

• System — Dell PowerEdge

yx2x

systems

NOTE: Here, y denotes alphabets, for example M, R, or T; and x denotes

numbers.

• Operating systems:

– SUSE Enterprise Linux 11 SP2 (64-bit)

–VMware ESXi 5.0 P1

•Browsers:

– Internet Explorer 9.0,

– Mozilla Firefox 7.0 and 6.0

Deprecated supported for the following:

16 Introduction

• System — Dell PowerEdge

xx8x

systems

• Operating system — Microsoft Windows Server 2003

•Browser — Mozilla Firefox 3.6

New Features

The added features are:

• Grouped BIOS attributes for configuring and reporting as per the system BIOS on PowerEdge

• System and setup passwords set through OMSA. Once set, provide the password for every BIOS attribute configuration.

• Licensed BIOS attributes (IPv6, Power budget, Dynamic DNS, and Dedicated NIC) that are available only with the appropriate installed license.

NOTE: Power profile, bootorder, and memorymode commands are not

supported on yx2x systems.

• Increased Automatic System Recovery (ASR) watchdog timer limit (increased from 480 seconds to 720 seconds.)

• Four additional platform events for Internal SD Module.

• Primary and failover network selection available for remote access (iDRAC7) NIC.

• Report on version for Power Supplies Unit (PSU) firmware.

• Short names for easier CLI parsing.

• Upgraded JRE Version (Version1.6 Update 30.)

• Power saving settings with the additional power saving modes in Manage Physical Disk Power controller task.

• Multiple backplanes and multiple internal controllers on PoweEdge systems.

NOTE: Creating virtual disks spanning multiple backplanes configured with different

controllers is not supported. On selected Dell PowerEdge yx2x systems, use PERC H710 mini and H710P adapters as secondary controllers for multiple internal controller configurations.

• Support for new controllers tasks, ability to convert to Non-RAID Disks and convert to RAID Capable Disks, convert unconfigured Ready RAID capable disks to Non-RAID disks and viceversa on Dell PERC H310 card.

yx2x

systems.

yx2x

Introduction 17

• Internal Tape Adapter (ITA) for LSI PCI-e U320 SCSI non-RAID controllers.

• Device management for PCI Express Solid-State Drive (PCIe SSD.)

• Physical Disk Power Management for Configured Drives feature on the PERC H710, PERC H710P, and PERC H810 controllers.

• As per the recommendation from Citrix, deprecated the web server support, on Citrix XenServer 6.0 managed servers, for loading domain 0 (dom0) with resource constrained operations.

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 the product.

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. Access the 32-bit command prompt using one of the following methods:

•Click

Start Programs Accessories Command Prompt

Start

Run

and type

cmd.exe

NOTE: 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 CLI.

18 Introduction

Primary CLI Commands

The commands that carry out the functions of Server Administrator are follows:

•

omconfig

•

omhelp

•

omreport

The omconfig command writes values that you assign to an object's properties. Specify values for warning thresholds on components or prescribe action the system must take when a certain warning or failure event occurs. Also, use the omconfig command to assign specific values to the 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 displays reports of the management information of the system.

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

Section Title Related Sections

Using the Instrumentation Service" on page 87

page 25

"omconfig system or servermodule assetinfo: Editing Cost of Ownership Values" on page 171

Introduction 19

Table 1-1. CLI Commands and Sections in This Guide

(continued)

Primary CLI 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]. For more information on corresponding CLI syntax, see the Dell Update Packages for Operating Systems User’s Guide or the Dell OpenManage Server Update Utility User’s Guide at support.dell.com/manuals.

Section Title Related Sections

Using the Instrumentation Service" on page 29

Additional useful topic about the CLI include:

• "Working With CLI Command Results" on page 281

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 the command is successful.

Success Messages

When you type a successful omconfig command, data for that component is displayed.

The following omconfig command examples displays 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

20 Introduction

Message:

BIOS setup configured successfully. Change will take effect after the next reboot.

Command:

omconfig system assetinfo info=depreciation duration=6

Message:

Asset information set successfully.

NOTE: Due to limitations, some commands do not alter the system settings

eventhough the commands are executed successfully. This is an expected behavior.

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 to execute the command successfully.

If you execute a command for a component or feature not present in the 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

Introduction 21

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

Message:

Voltage probe warning threshold(s) set successfully.

Scripting and Comparing With the CLI

The Server Administrator CLI allows administrators to write batch programs for 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 is used to populate a large number of newly acquired systems with detailed asset information. Much of the information are the same, such as the manufacturer or lessor of the system, whether support for the system is outsourced, insurance company name of the system, method of depreciation, and so on. Any variable that is common to all systems are scripted, sent to all managed systems, and executed. Asset information that is unique to a system is 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.

22 Introduction

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 are routed to a file for later analysis. Reports can help administrators gain information that are 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 the 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

Introduction 23

The preceding displays a list of alert actions that are configured for components on the system.

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

24 Introduction

command level 3

name=value pair 1

name=value pair 2

Using the omhelp Command

The omhelp command and its equivalent, <command> -?, accesses the detailed help text interface of Command Line Interface (CLI.) 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

Using the omhelp Command 25

• recovery

• shutdown

• thrmshutdown

• webserver

Figure 2-1 shows the levels of help for a command.

Figure 2-1. Different Levels of Help for a Command

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

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

28 Using the omhelp Command

omreport: Viewing System Status Using the Instrumentation Service

The omreport command allows you to see detailed information about the system components. Retrieve summaries for many system components at one time, or 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, 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 87.

Use omreport commands to get information you need to execute an omconfig command. For example, to edit the minimum temperature for a warning event on a temperature probe, you must know the index of the probe you want to configure. 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 Blade systems

servermodule Blade systems

mainsystem Blade systems

system Rack and Tower systems

chassis Rack and Tower systems

preferences Blade or Rack, and Tower

systems

omreport: Viewing System Status Using the Instrumentation Service 29

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 enable or disable the component or feature.

Command Summary of the omreport Command

Although this chapter lists all possible omreport commands, the commands available on the system depend on the system configuration. The results of 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 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.

Enterprise Linux

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 to 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 performed using omreport. More details about syntax and use of the command appear later in this section.

Tab le 3- 2 di spl ays 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" on page 29.

30 omreport: Viewing System Status Using the Instrumentation Service

+ 272 hidden pages