Dell OpenManage Server Administrator Version 7.1 Command Line Interface Guide

Dell OpenManage

Server Administrator

Version 7.1

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

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

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

What's New in This Release

Accessing the Windows Command Prompt to Run CLI Commands

Primary CLI Commands . . . . . . . . . . . . . . . . . 18

CLI Error Checking and Error Messages

Success Messages

Failure Messages

Scripting and Comparing Using CLI

Command Syntax Overview

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

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

. . . . . . . . 19

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

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

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

. . . . . . . . . . . . . . . 22

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

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

3 omreport: Viewing System Status

Using the Instrumentation Service

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

. . . . . 29

Command Summary of the omreport Command

Help With the omreport Command

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

. . . . 30

Contents 3

omreport modularenclosure . . . . . . . . . . . . . . . 37

omreport about

. . . . . . . . . . . . . . . . . . . . . 38

omreport chassis or omreport mainsystem Commands

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

omreport chassis or omreport mainsystem

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

omreport chassis memory or omreport mainsystem memory

. . . . . . . . . . . . . . . . 53

. . . . 39

4 Contents

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

omreport chassis pwrmonitoring or omreport mainsystem pwrmonitoring

. . . . . . . 61

omreport chassis pwrsupplies or

omreport mainsystem pwrsupplies . . . . . . . . 65

omreport chassis remoteaccess or

omreport mainsystem remoteaccess . . . . . . . 65

omreport chassis slots or omreport

mainsystem slots

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

omreport chassis temps or omreport

mainsystem temps . . . . . . . . . . . . . . . . . 67

omreport chassis volts or omreport

mainsystem volts . . . . . . . . . . . . . . . . . . 67

omreport system Commands or omreport servermodule Commands

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

omreport system or omreport servermodule

Commands for Viewing Logs

. . . . . . . . . . . . 69

omreport system alertaction or omreport servermodule alertaction

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

omreport system assetinfo or omreport

servermodule assetinfo . . . . . . . . . . . . . . 72

omreport system events or omreport servermodule events

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

omreport system operatingsystem or omreport

servermodule operatingsystem . . . . . . . . . . 75

omreport system pedestinations or omreport

servermodule pedestinations

. . . . . . . . . . . 75

omreport system platformevents or omreport

servermodule platformevents

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

. . . 68

Contents 5

omreport system recovery or omreport servermodule recovery

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

omreport system shutdown or omreport servermodule shutdown

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

omreport system summary or omreport

servermodule summary . . . . . . . . . . . . . . 78

omreport system thrmshutdown or omreport

servermodule thrmshutdown . . . . . . . . . . . . 86

omreport system version or omreport servermodule version

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

omreport preferences Commands

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

4 omconfig: Managing Components Using

the Instrumentation Service . . . . . . . . . . 89

Conventions for Parameter Tables . . . . . . . . . 90

omconfig Command Summary . . . . . . . . . . . . . . 90

Help With the omconfig Command

omconfig about

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

omconfig chassis or omconfig mainsystem

omconfig chassis biossetup or omconfig mainsystem biossetup

omconfig chassis currents or omconfig mainsystem currents

omconfig chassis fans or omconfig mainsystem fans

. . . . . . . . . . . . . . . . . . 122

omconfig chassis frontpanel or omconfig

mainsystem frontpanel . . . . . . . . . . . . . . . 124

omconfig chassis info or omconfig

mainsystem info . . . . . . . . . . . . . . . . . . 126

omconfig chassis leds or omconfig mainsystem leds

. . . . . . . . . . . . . . . . . . 127

. . . . . . . . . . . 95

. . . . . . . 98

. . . . . . . . . . . . . . . 98

. . . . . . . . . . . . . . . . 122

6 Contents

omconfig chassis memorymode or omconfig mainsystem memorymode

. . . . . . . . 127

omconfig chassis pwrmanagement or omconfig mainsystem pwrmanagement

. . . . . . 130

omconfig chassis pwrmonitoring or

omconfig mainsystem pwrmonitoring . . . . . . . 132

omconfig chassis remoteaccess or

omconfig mainsystem remoteaccess . . . . . . . 134

omconfig chassis temps or omconfig mainsystem temps

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

omconfig chassis volts or omconfig

mainsystem volts . . . . . . . . . . . . . . . . . . 150

omconfig preferences

omconfig preferences cdvformat

omconfig preferences dirservice

omconfig preferences snmp

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

. . . . . . . . . 151

. . . . . . . . . 152

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

omconfig preferences useraccess . . . . . . . . 154

omconfig preferences webserver

omconfig system or omconfig servermodule

. . . . . . . . . 155

. . . . . . 156

omconfig system alertaction or omconfig servermodule alertaction

. . . . . . . . . . . . . 156

Commands for Clearing Logs . . . . . . . . . . . 161

omconfig system pedestinations or omconfig servermodule pedestinations

. . . . . . . . . . . 162

omconfig system platformevents or omconfig servermodule platformevents

. . . . . . . . . . . 162

omconfig system events or omconfig

servermodule events . . . . . . . . . . . . . . . . 166

omconfig system webserver or omconfig servermodule webserver

. . . . . . . . . . . . . 169

Contents 7

omconfig system recovery or omconfig servermodule recovery

. . . . . . . . . . . . . . . 169

omconfig system shutdown or omconfig servermodule shutdown

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

omconfig system thrmshutdown or omconfig

servermodule thrmshutdown . . . . . . . . . . . . 172

5 omconfig system or servermodule

assetinfo: Editing Cost of

Ownership Values . . . . . . . . . . . . . . . . . 175

User Level Required for Adding Asset

Information . . . . . . . . . . . . . . . . . . . . . 175

Adding Acquisition Information

. . . . . . . . . . . . . 175

Example Commands for Adding Acquisition Information

Adding Depreciation Information

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

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

Example Commands for Adding Depreciation Information

Adding Extended Warranty Information

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

. . . . . . . . 179

Example Command for Adding Extended Warranty Information

Adding Lease Information

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

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

Example Command for Adding Lease Information

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

Adding Maintenance Information . . . . . . . . . . . . 182

Example Command for Adding Maintenance Information

Adding Outsource Information

. . . . . . . . . . . . . . . . . . . . . 183

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

Example Command for Adding Outsource Information

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

8 Contents

Adding Owner Information . . . . . . . . . . . . . . . 186

Example Command for Adding Owner Information

. . . . . . . . . . . . . . . . . . . . . 186

Adding Service Contract Information . . . . . . . . . . 187

Example Command for Adding Service Information

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

Adding Support Information . . . . . . . . . . . . . . . 188

Example Command for Adding Support Information

. . . . . . . . . . . . . . . . . . . . . 189

Adding System Information . . . . . . . . . . . . . . . 190

Example Command for Adding System Information

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

Adding Warranty Information . . . . . . . . . . . . . . 191

Example Command for Adding Warranty Information

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

6 Using the Storage Management

Service . . . . . . . . . . . . . . . . . . . . . . . . . 195

CLI Command Syntax . . . . . . . . . . . . . . . . . . 195

Syntax for Required, Optional, and Variable Command Elements

. . . . . . . . . . . . . . . . . . . 196

User Privileges for omreport storage and omconfig storage

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

7 omreport storage Commands . . . . . . . . 199

omreport Physical Disk Status . . . . . . . . . . . . . 200

omreport Virtual Disk Status

. . . . . . . . . . . . . . 202

Contents 9

omreport Controller Status . . . . . . . . . . . . . . . 203

omreport Enclosure Status

omreport Temperature Probe Status

omreport Fan Status

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

. . . . . . . . 205

. . . . . . . . . . . . . . . . 206

omreport Power Supply Status . . . . . . . . . . . 207

omreport EMM Status

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

omreport Enclosure Slot Occupancy

Report . . . . . . . . . . . . . . . . . . . . . . . . 209

omreport Battery Status . . . . . . . . . . . . . . . . . 209

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

omreport Connector Status

omreport Cachecade Status

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

. . . . . . . . . . . . . . . 212

. . . . 210

8 omconfig storage Commands . . . . . . . . 213

omconfig Physical Disk Commands . . . . . . . . . . . 214

omconfig Blink Physical Disk

omconfig Unblink Physical Disk

omconfig Prepare to Remove Physical Disk

omconfig Instant Erase Secured Physical

. . . . . . . . . . . . . . . . . . . . . . . . . 217

Disk

omconfig Initialize Physical Disk

omconfig Offline Physical Disk . . . . . . . . . . . 219

omconfig Online Physical Disk

omconfig Assign Global Hot Spare

omconfig Rebuild Physical Disk

omconfig Cancel Rebuild Physical Disk

omconfig Cancel Replace Member

omconfig Clear Physical Disk

omconfig Cancel Clear Physical Disk

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

. . . . . . . . . . 216

. . . . 217

. . . . . . . . . . 218

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

. . . . . . . . . 220

. . . . . . . . . . 221

. . . . . . 222

. . . . . . . . 222

. . . . . . . . . . . 223

. . . . . . . 223

10 Contents

omconfig Enable Device Write Cache . . . . . . . 224

omconfig Disable Device Write Cache . . . . . . 225

omconfig Export Reliability Log

omconfig Convert RAID to Non-RAID

. . . . . . . . . . 225

. . . . . . . 226

omconfig Convert Non-RAID to RAID . . . . . . . 227

omconfig Virtual Disk Commands . . . . . . . . . . . 228

omconfig Check Consistency

. . . . . . . . . . . 229

omconfig Cancel Check Consistency . . . . . . . 229

omconfig Pause Check Consistency

omconfig Resume Check Consistency

. . . . . . . . 230

. . . . . . . 231

omconfig Blink Virtual Disk . . . . . . . . . . . . 231

omconfig Unblink Virtual Disk

omconfig Initialize Virtual Disk

. . . . . . . . . . . 232

omconfig Fast Initialize Virtual Disk . . . . . . . . 233

omconfig Slow Initialize Virtualize Disk

omconfig Cancel Initialize Virtual Disk

. . . . . . 233

. . . . . . . 234

omconfig Cancel Background Initialize . . . . . . 235

omconfig Assign Dedicated Hot Spare

. . . . . . 235

omconfig Delete Virtual Disk . . . . . . . . . . . . 236

omconfig Format Virtual Disk

omconfig Reconfiguring Virtual Disks

. . . . . . . . . . . 237

. . . . . . . 237

omconfig Secure Virtual Disk . . . . . . . . . . . 239

omconfig Clear Virtual Disk Bad Blocks

omconfig Change Virtual Disk Policy

. . . . . . 239

. . . . . . . 240

omconfig Replace Member Virtual Disk . . . . . . 241

omconfig Rename Virtual Disk

. . . . . . . . . . . 242

omconfig Controller Commands

omconfig Rescan Controller

omconfig Enable Controller Alarm

omconfig Disable Controller Alarm

omconfig Quiet Controller Alarm

omconfig Test Controller Alarm

. . . . . . . . . . . . 242

. . . . . . . . . . . . 245

. . . . . . . . . 245

. . . . . . . . 246

. . . . . . . . . . 246

. . . . . . . . . . 247

Contents 11

omconfig Reset Controller Configuration . . . . . 248

omconfig Create Virtual Disk . . . . . . . . . . . . 248

omconfig Set Controller Rebuild Rate

omconfig Change Controller Properties

. . . . . . . 254

. . . . . . 255

omconfig Discard Preserved Cache . . . . . . . . 255

omconfig Create Encryption Key

omconfig Change Encryption Key

. . . . . . . . . . 256

. . . . . . . . . 256

omconfig Delete Encryption Key . . . . . . . . . . 257

omconfig Set Background Initialization Rate

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

omconfig Set Reconstruct Rate . . . . . . . . . . 258

omconfig Set Check Consistency Rate

omconfig Export the Controller Log

. . . . . . . 258

. . . . . . . . 259

omconfig Import Secure Foreign

Configuration . . . . . . . . . . . . . . . . . . . . 260

omconfig Import Foreign Configuration

. . . . . . 260

omconfig Import or Recover Foreign

Configuration . . . . . . . . . . . . . . . . . . . . 261

omconfig Clear Foreign Configuration

. . . . . . . 261

omconfig Physical Disk Power

Management . . . . . . . . . . . . . . . . . . . . 262

omconfig Set Patrol Read Mode . . . . . . . . . . 263

omconfig Start Patrol Read

omconfig Stop Patrol Read

omconfig Create Cachecade

omconfig Enable LKM Controller

omconfig Rekey LKM Controller

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

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

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

. . . . . . . . . . 265

omconfig Convert Multiple RAID to

Non-RAID . . . . . . . . . . . . . . . . . . . . . . 266

omconfig Convert Multiple Non-RAID to

RAID . . . . . . . . . . . . . . . . . . . . . . . . 266

12 Contents

Omconfig Enclosure Commands

omconfig Enable Enclosure Alarm

omconfig Disable Enclosure Alarm

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

. . . . . . . . . 268

. . . . . . . . 268

omconfig Set Enclosure Asset Tag . . . . . . . . 269

omconfig Set Enclosure Asset Name . . . . . . . 270

omconfig Set Temperature Probe Thresholds

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

omconfig Reset Temperature Probe

Thresholds . . . . . . . . . . . . . . . . . . . . . 271

omconfig Set All Temperature Probe

Thresholds . . . . . . . . . . . . . . . . . . . . . 272

omconfig Reset All Temperature Probe Thresholds

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

omconfig Blink . . . . . . . . . . . . . . . . . . . 273

omconfig Battery Commands . . . . . . . . . . . . . . 274

omconfig Start Battery Learn Cycle

. . . . . . . . 274

omconfig Delay Battery Learn Cycle . . . . . . . . 275

omconfig Global Commands . . . . . . . . . . . . . . 275

omconfig Global Enable Smart Thermal Shutdown

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

omconfig Global Disable Smart Thermal Shutdown

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

omconfig Global Rescan Controller . . . . . . . . 278

omconfig Set Hot Spare Protection Policy

. . . . 278

omconfig Connector Commands

omconfig Rescan Connector

omconfig Cachecade Commands

omconfig Blink Cachecade

omconfig Unblink Cachecade

omconfig Delete Cachecade

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

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

. . . . . . . . . . . 281

. . . . . . . . . . . . 281

omconfig Resize Cachecade . . . . . . . . . . . . 282

omconfig Rename Cachecade

. . . . . . . . . . . 283

Contents 13

9 Working With CLI Command

Results . . . . . . . . . . . . . . . . . . . . . . . . . . 285

Output Options for Command Results . . . . . . . . . . 285

Controlling Command Output Display

Writing Command Output to a File

. . . . . . . . . . 285

. . . . . . . . . . . 286

Saving Command Results to a File That is Overwritten

. . . . . . . . . . . . . . . . . 286

Append Command Results to an

Existing File . . . . . . . . . . . . . . . . . . . . . 287

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

List (lst)

. . . . . . . . . . . . . . . . . . . . . . . 289

Table (tbl) . . . . . . . . . . . . . . . . . . . . . . 290

Semicolon-separated Values (ssv)

Custom Delimited Format (cdv)

. . . . . . . . . 291

. . . . . . . . . . . 291

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

14 Contents

Introduction

Overview

Dell OpenManage Server Administrator (OMSA) provides a comprehensive, one-to-one systems management solution through either an integrated Web browser-based graphical user interface (GUI) or a command line interface (CLI). 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 a comprehensive one-toone 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. Server Administrator enables you to access remotely monitored systems by dial-in, LAN, or wireless connections.

The configuration features enable 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 enable retrieval of the overall health status for systems on the network. You can view information about voltage, temperature, fan's revolutions per minute (RPM), memory functioning, and many other critical details at the component level. You can also see a detailed account of the cost of ownership (COO) about the system, retrieve version information about the 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. Run the omconfig system webserver action=stop command to turn off the Web server. The Web server starts automatically after a reboot, so run this command each time a system starts up. See "omconfig system webserver or omconfig servermodule webserver" on page 169 for more information.

NOTE: After installing 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 the terms used in this document, see the Glossary at

support.dell.com/manuals.

What's New in This Release

The release highlights of OpenManage Server Administrator are:

• Support for the following operating systems:

– Red Hat Enterprise Linux 5.8 (64-bit and 32-bit)

– Red Hat Enterprise Linux 6.2 (64-bit)

– VMware ESXi 5.0 Update 1

• Support for the following Dell PowerEdge systems: M820, T420, and T320

• Support for PowerEdge custom branding. For more information, see

• Support for the following Network Interface Cards (NICs), Converged Network Adapters

– Brocade 10Gb CNA (BR1020 and BR1741M-k)

– Emulex Single Port FC16 HBA

– Emulex Dual Port FC16 HBA

– Qlogic QLE2460 Single Port FC4 Adapter

OEM Ready

server models that allow reseller

dell.com/oem

(CNAs), and Fibre Channels (FCs):

16 Introduction

– Qlogic QLE2462 Dual Port FC4 Adapter

– Brocade BR815- Single Port FC8 Adapter

– Brocade BR825- Dual Port FC8 Adapter

– Qlogic QLE2562 Dual Port FC8 Adapter

– Emulex LPe-12002 Dual Port FC8 Adapter

– Qlogic QME2572 Dual Port FC8 Mezz

– Emulex Lpe-1205-M Dual Port FC8 Mezz

– Qlogic QLE2560 Single Port FC8 Adapter

– Emulex LPe-12000 Single Port FC8 Adapter

– Broadcom 57810 Dual Port 10GbE KR Blade Converged

Mezzanine Card

– Broadcom 57810 Dual Port 10Gb Base-T

– Broadcom 57810 Dual Port 10GbE SFP

– Qlogic QME8252-K Mezz

– Qlogic P3+ Dual Port 10Gb SFP+/DA

• Support for the following Web browsers: Mozilla Firefox 10, 11, and 12 browsers

• Deprecated support for the following operating systems:

– RedHat Enterprise Linux 5 SP7 (32-bit and 64-bit)

– RedHat Enterprise Linux 6 SP1 (64-bit)

–

VMware ESXi 5.0

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.

Introduction 17

Accessing the Windows Command Prompt to Run CLI Commands

If you are running the Microsoft Windows operating system, use the 32-bit command prompt to run a Server Administrator CLI command. Access the 32-bit command prompt using one of the following methods:

•Click

Start Programs Accessories Command Prompt

Start

NOTE: Do not type command in 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.

Run

and type

cmd.exe

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 action that the system must perform when a certain warning or failure event occurs. You can 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 the CLI commands, type omhelp.

18 Introduction

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

omreport "omreport: Viewing System Status

NOTE: The omupdate commands are no longer supported in Server Administrator

and are replaced by Dell Update Package or the Server Update Utility commands. To update the different components, download the Dell Update Package and run the

Section Title Related Sections

"omconfig system or Using the Instrumentation Service" on page 89

page 25

Using the Instrumentation Service" on page 29

servermodule assetinfo: Editing

Cost of Ownership Values" on

page 175

<package name> /s [/f]command. For more information on the

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.

Additional useful topic about the CLI include:

• "Working With CLI Command Results" on page 285

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 is displayed, stating that the command is successful.

Success Messages

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

The following table provides examples of valid omconfig commands and their success messages.

Introduction 19

Table 1-2. Commands and Messages

Command Message

omconfig chassis temps index=0 warnthresh= default

Temperature probe warning threshold value(s) set successfully.

omconfig chassis biossetup attribute=numlock setting=on

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

omconfig system assetinfo info=depreciation

Asset information set successfully.

duration=6

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

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

If you execute a command for a component or feature that is 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

20 Introduction

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.

Revised command:

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

Message:

Voltage probe warning threshold(s) set successfully.

Scripting and Comparing Using 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.

Introduction 21

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, name of the company providing insurance for the system, method of depreciation, and so on. Any variable that is common to all systems is 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 the 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 highest 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 display a very brief summary. The summary shows version information for the systems management software installed on the system; for example, Server Administrator 1.x.

22 Introduction

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, the following command displays a list of alert actions that are configured for components on a system.

omreport system alertaction

The most complex commands have all three command levels and can have multiple name=value pairs. The following is an example of two name=value pairs:

omconfig system assetinfo info=depreciation duration=3

The following is 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 chapter of this document, command syntax and other information about the commands are formatted using any of the following fields as appropriate:

command level 1

command level 2

command level 3

name=value pair 1

name=value pair 2

Introduction 23

24 Introduction

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 is displayed 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 lists 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. You can also 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. The 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 89.

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

The omreport commands available on the system depend on the system configuration. Table 3-1 lists the systems on which the omreport commands are applicable.

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 for a command, the parameters are listed in alphabetical order instead of the order in which they appear in the command line interface (CLI).

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 may vary from one system to another. The omreport command displays data for the 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 provides a high-level summary of the omreport command. The column titled Command level 1 shows the omreport command at its most general use. 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 run 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 the syntax and use of the command appear later in this section.

Tab le 3 -2 l is ts th e 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

+ 276 hidden pages