Dell OpenManage Server Administrator Version 7.4 Command Line Interface Guide

Dell OpenManage Server Administrator Version 7.4 Command Line Interface Guide
Notes, Cautions, and Warnings
NOTE: A NOTE indicates important information that helps you make better use of your computer.
CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the problem.
WARNING: A WARNING indicates a potential for property damage, personal injury, or death.
Copyright © 2014 Dell Inc. All rights reserved. This product is protected by U.S. and international copyright and
intellectual property laws. Dell™ and the Dell logo are trademarks of Dell Inc. in the United States and/or other jurisdictions. All other marks and names mentioned herein may be trademarks of their respective companies.
2014 - 03
Rev. A00
Contents
1 Introduction.............................................................................................................. 11
What's New In This Release.................................................................................................................11
Accessing The Windows Command Prompt To Run CLI Commands..............................................13
Primary CLI Commands...................................................................................................................... 13
CLI Error Checking And Error Messages............................................................................................ 14
Success Messages......................................................................................................................... 14
Failure Messages............................................................................................................................14
Scripting And Comparing Using CLI................................................................................................... 15
Command Syntax Overview................................................................................................................15
2 Using The omhelp Command.............................................................................. 17
Example Help Commands...................................................................................................................17
3 omreport: Viewing System Status Using The Instrumentation Service....19
Conventions For Parameter Tables.................................................................................................... 19
Command Summary Of The omreport Command...........................................................................20
Help With The omreport Command.................................................................................................. 23
omreport modularenclosure.............................................................................................................. 23
omreport about...................................................................................................................................24
Omreport Chassis Or Omreport Mainsystem Commands................................................................25
Omreport Chassis Acswitch Or Omreport Mainsystem Acswitch.............................................. 25
Omreport Chassis Batteries Or Omreport Mainsystem Batteries............................................... 26
Omreport Chassis Bios Or Omreport Mainsystem Bios..............................................................26
Omreport Chassis Biossetup Or Omreport Mainsystem Biossetup............................................26
BIOS Setup Parameters On Systems Prior To PowerEdge 12G Systems.................................... 27
BIOS Setup Groups On PowerEdge yx2x Systems...................................................................... 29
Omreport Chassis Currents Or Omreport Mainsystem Currents............................................... 30
Omreport Chassis Fans Or Omreport Mainsystem Fans.............................................................30
Omreport Chassis Firmware Or Omreport Mainsystem Firmware.............................................30
Omreport Chassis Frontpanel Or Omreport Mainsystem Frontpanel.........................................31
Omreport Chassis Fru Or Omreport Mainsystem Fru..................................................................31
Omreport Chassis Hwperformance Or Omreport Mainsystem Hwperformance...................... 31
Omreport Chassis Info Or Omreport Mainsystem Info...............................................................32
Omreport Chassis Intrusion..........................................................................................................32
Omreport Chassis Leds Or Omreport Mainsystem Leds.............................................................33
Omreport Chassis Memory Or Omreport Mainsystem Memory.................................................33
Omreport Chassis Nics Or Omreport Mainsystem Nics..............................................................35
Omreport Chassis Ports Or omreport Mainsystem Ports............................................................36
Omreport Chassis Processors Or Omreport Mainsystem Processors........................................36
Omreport Chassis Pwrmanagement Or Omreport Mainsystem Pwrmanagement...................39
Omreport Chassis Pwrmonitoring Or Omreport Mainsystem Pwrmonitoring..........................40
Omreport Chassis Pwrsupplies Or Omreport Mainsystem Pwrsupplies.................................... 42
Omreport Chassis Remoteaccess Or Omreport Mainsystem Remoteaccess........................... 42
Omreport Chassis Removableflashmedia Or Omreport Mainsystem
Removableflashmedia...................................................................................................................43
Omreport Chassis Slots Or Omreport Mainsystem Slots............................................................44
Omreport Chassis Temps Or Omreport Mainsystem Temps..................................................... 44
Omreport Chassis Volts Or Omreport Mainsystem Volts........................................................... 44
Omreport Licenses..............................................................................................................................45
Omreport System Commands Or Omreport Servermodule Commands........................................45
Omreport System Or Omreport Servermodule...........................................................................45
Commands For Viewing Logs...................................................................................................... 46
Omreport System Alertaction Or Omreport Servermodule Alertaction.....................................46
Omreport System Assetinfo Or Omreport Servermodule Assetinfo...........................................48
Omreport System Events Or Omreport Servermodule Events................................................... 48
Omreport System Events Type Or Omreport Servermodule Events Type.................................49
Omreport System Operatingsystem Or Omreport Servermodule Operatingsystem................ 50
Omreport System Pedestinations Or Omreport Servermodule Pedestinations........................ 50
Omreport System Platformevents Or Omreport Servermodule Platformevents....................... 51
Omreport System Recovery Or Omreport Servermodule Recovery.......................................... 52
Omreport System Shutdown Or Omreport Servermodule Shutdown....................................... 52
Omreport System Summary Or Omreport Servermodule Summary..........................................52
Omreport System Thrmshutdown Or Omreport Servermodule Thrmshutdown...................... 57
Omreport System Version Or Omreport Servermodule Version................................................ 57
Omreport Preferences Commands....................................................................................................58
Omreport Preferences Messages................................................................................................. 58
Omreport Preferences Webserver................................................................................................58
4 Omconfig: Managing Components Using The Instrumentation
Service...........................................................................................................................61
Conventions For Parameter Tables.................................................................................................... 61
omconfig Command Summary..........................................................................................................62
Help With The Omconfig Command.................................................................................................64
Omconfig About................................................................................................................................. 65
Omconfig Chassis Or Omconfig Mainsystem................................................................................... 66
Omconfig Chassis Biossetup Or Omconfig Mainsystem Biossetup...........................................66
Omconfig Chassis Currents Or Omconfig Mainsystem Currents...............................................83
Omconfig Chassis Fans Or Omconfig Mainsystem Fans............................................................ 83
Omconfig Chassis Frontpanel Or Omconfig Mainsystem Frontpanel....................................... 84
Omconfig Chassis Info Or Omconfig Mainsystem Info.............................................................. 85
Omconfig Chassis Leds Or Omconfig Mainsystem Leds............................................................86
Omconfig Chassis Memorymode Or Omconfig Mainsystem Memorymode............................ 86
Omconfig Chassis Pwrmanagement Or Omconfig Mainsystem Pwrmanagement.................. 88
Omconfig Chassis Pwrmonitoring Or Omconfig Mainsystem Pwrmonitoring......................... 89
Omconfig Chassis Remoteaccess Or Omconfig Mainsystem Remoteaccess........................... 91
Omconfig Chassis Temps Or Omconfig Mainsystem Temps.....................................................99
Omconfig Chassis Volts Or Omconfig Mainsystem Volts.........................................................100
Omconfig Preferences......................................................................................................................101
Omconfig Preferences Cdvformat............................................................................................. 101
Omconfig Preferences Dirservice...............................................................................................101
Omconfig Preferences Messages...............................................................................................102
Omconfig Preferences Useraccess............................................................................................ 102
Omconfig Preferences Webserver............................................................................................. 102
Omconfig System Or Omconfig Servermodule.............................................................................. 103
Omconfig System Alertaction Or Omconfig Servermodule Alertaction.................................. 103
Commands For Clearing Logs....................................................................................................107
Omconfig System Pedestinations Or Omconfig Servermodule Pedestinations...................... 107
Omconfig System Platformevents Or Omconfig Servermodule Platformevents.................... 108
Omconfig System Events Or Omconfig Servermodule Events.................................................110
Omconfig System Webserver Or Omconfig Servermodule Webserver....................................112
Omconfig System Recovery Or Omconfig Servermodule Recovery........................................113
Omconfig System Shutdown Or Omconfig Servermodule Shutdown.....................................113
Omconfig System Thrmshutdown Or Omconfig Servermodule Thrmshutdown....................114
5 Omconfig System Or Servermodule Assetinfo: Editing Cost Of
Ownership Values.....................................................................................................117
Adding Acquisition Information.........................................................................................................117
Example Command For Adding Acquisition Information..........................................................118
Adding Depreciation Information..................................................................................................... 119
Example Command For Adding Depreciation Information...................................................... 120
Adding Extended Warranty Information...........................................................................................120
Example Command For Adding Extended Warranty Information.............................................121
Adding Lease Information................................................................................................................. 121
Example Command For Adding Lease Information...................................................................122
Adding Maintenance Information.....................................................................................................122
Example Command For Adding Maintenance Information.......................................................122
Adding Outsource Information.........................................................................................................123
Example Command For Adding Outsource Information.......................................................... 123
Adding Owner Information...............................................................................................................124
Example Command For Adding Owner Information.................................................................124
Adding Service Contract Information...............................................................................................124
Example Command For Adding Service Information................................................................ 125
Adding Support Information............................................................................................................. 125
Example Command For Adding Support Information...............................................................126
Adding System Information.............................................................................................................. 126
Example Command For Adding System Information................................................................ 127
Adding Warranty Information........................................................................................................... 127
Example Command For Adding Warranty Information.............................................................128
6 Using The Storage Management Service........................................................129
CLI Command Syntax....................................................................................................................... 129
Syntax Of Command Elements........................................................................................................ 130
User Privileges For Omreport Storage And Omconfig Storage.......................................................131
7 Omreport Storage Commands..........................................................................133
Omreport Physical Disk Status......................................................................................................... 134
omreport Virtual Disk Status.............................................................................................................134
Omreport Controller Status..............................................................................................................135
Omreport Enclosure Status.............................................................................................................. 135
Omreport Temperature Probe Status.........................................................................................136
Omreport Fan Status...................................................................................................................136
Omreport Power Supply Status.................................................................................................. 137
Omreport EMM Status.................................................................................................................138
Omreport Enclosure Slot Occupancy Report............................................................................138
Omreport Battery Status...................................................................................................................139
Omreport Global Information.......................................................................................................... 139
Omreport Connector Status............................................................................................................ 140
Omreport Cachecade Status............................................................................................................140
Omreport PCIe SSD Status............................................................................................................... 140
Omreport Fluid Cache Status............................................................................................................141
Omreport Fluid Cache Pool Status...................................................................................................141
omreport Partition Status..................................................................................................................141
Omreport Fluid Cache Disk Status....................................................................................................141
Omreport Storage Tape....................................................................................................................142
8 Omconfig Storage Commands......................................................................... 143
Omconfig Physical Disk Commands................................................................................................144
Omconfig Blink Physical Disk..................................................................................................... 144
Omconfig Unblink Physical Disk.................................................................................................145
Omconfig Prepare To Remove Physical Disk............................................................................ 145
Omconfig Instant Erase Secured Physical Disk......................................................................... 146
Omconfig Cryptographic Erase Secured Physical Disk.............................................................146
Omconfig Initialize Physical Disk................................................................................................147
Omconfig Offline Physical Disk.................................................................................................. 147
Omconfig Online Physical Disk.................................................................................................. 148
Omconfig Assign Global Hot Spare............................................................................................148
Omconfig Rebuild Physical Disk.................................................................................................148
Omconfig Cancel Rebuild Physical Disk.................................................................................... 149
Omconfig Cancel Replace Member...........................................................................................150
Omconfig Clear Physical Disk.................................................................................................... 150
Omconfig Cancel Clear Physical Disk........................................................................................150
Omconfig Enable Device Write Cache....................................................................................... 151
Omconfig Disable Device Write Cache...................................................................................... 151
Omconfig Export Reliability Log................................................................................................. 152
Omconfig Convert RAID To Non-RAID......................................................................................152
Omconfig Convert Non-RAID To RAID......................................................................................153
Omconfig Virtual Disk Commands...................................................................................................153
Omconfig Check Consistency....................................................................................................154
Omconfig Cancel Check Consistency....................................................................................... 155
Omconfig Pause Check Consistency.........................................................................................155
Omconfig Resume Check Consistency..................................................................................... 155
Omconfig Blink Virtual Disk........................................................................................................ 156
Omconfig Unblink Virtual Disk....................................................................................................156
Omconfig Initialize Virtual Disk...................................................................................................156
Omconfig Fast Initialize Virtual Disk...........................................................................................156
Omconfig Slow Initialize Virtualize Disk..................................................................................... 157
Omconfig Cancel Initialize Virtual Disk...................................................................................... 157
Omconfig Cancel Background Initialize.................................................................................... 158
Omconfig Assign Dedicated Hot Spare......................................................................................158
Omconfig Delete Virtual Disk..................................................................................................... 158
Omconfig Format Virtual Disk.................................................................................................... 159
Omconfig Reconfiguring Virtual Disks....................................................................................... 159
Omconfig Secure Virtual Disk.................................................................................................... 160
Omconfig Clear Virtual Disk Bad Blocks....................................................................................160
Omconfig Change Virtual Disk Policy.........................................................................................161
Omconfig Replace Member Virtual Disk.................................................................................... 161
Omconfig Rename Virtual Disk...................................................................................................161
Omconfig Enable Fluid Cache on Virtual Disk...........................................................................162
Omconfig Disable Fluid Cache on Virtual Disk.......................................................................... 162
Omconfig Reactivate Fluid Cache on Virtual Disk.....................................................................162
Omconfig Controller Commands.................................................................................................... 163
Omconfig Rescan Controller......................................................................................................165
Omconfig Enable Controller Alarm............................................................................................165
Omconfig Disable Controller Alarm...........................................................................................165
Omconfig Quiet Controller Alarm..............................................................................................165
omconfig Test Controller Alarm.................................................................................................166
Omconfig Reset Controller Configuration................................................................................ 166
omconfig Create Virtual Disk......................................................................................................166
Omconfig Set Controller Rebuild Rate.......................................................................................173
omconfig Change Controller Properties....................................................................................173
Omconfig Discard Preserved Cache.......................................................................................... 174
Omconfig Create Encryption Key...............................................................................................174
Omconfig Change Encryption Key.............................................................................................175
Omconfig Delete Encryption Key............................................................................................... 175
Omconfig Set Background Initialization Rate............................................................................ 175
Omconfig Set Reconstruct Rate................................................................................................. 175
Omconfig Set Check Consistency Rate..................................................................................... 176
Omconfig Export The Controller Log.........................................................................................176
Omconfig Import Secure Foreign Configuration.......................................................................176
Omconfig Import Foreign Configuration................................................................................... 177
Omconfig Import Or Recover Foreign Configuration............................................................... 177
Omconfig Clear Foreign Configuration......................................................................................177
Omconfig Physical Disk Power Management............................................................................ 177
Omconfig Set Patrol Read Mode................................................................................................178
Omconfig Start Patrol Read........................................................................................................ 178
Omconfig Stop Patrol Read........................................................................................................ 178
Omconfig Create Cachecade.....................................................................................................179
Omconfig Enable LKM Controller...............................................................................................179
Omconfig Rekey LKM Controller................................................................................................179
Omconfig Convert Multiple RAID To Non-RAID....................................................................... 179
Omconfig Convert Multiple Non-RAID To RAID.......................................................................180
Omconfig Enclosure Commands.................................................................................................... 180
Omconfig Enable Enclosure Alarm............................................................................................ 180
Omconfig Disable Enclosure Alarm............................................................................................181
Omconfig Set Enclosure Asset Tag.............................................................................................181
Omconfig Set Enclosure Asset Name.........................................................................................181
Omconfig Set Temperature Probe Thresholds..........................................................................182
Omconfig Reset Temperature Probe Thresholds......................................................................182
Omconfig Set All Temperature Probe Thresholds.....................................................................183
Omconfig Reset All Temperature Probe Thresholds.................................................................183
Omconfig Blink............................................................................................................................183
Omconfig Battery Commands......................................................................................................... 184
omconfig Start Battery Learn Cycle........................................................................................... 184
Omconfig Delay Battery Learn Cycle.........................................................................................184
Omconfig Global Commands.......................................................................................................... 184
Omconfig Global Enable Smart Thermal Shutdown................................................................. 185
Omconfig Global Disable Smart Thermal Shutdown................................................................ 185
Omconfig Global Rescan Controller..........................................................................................186
Omconfig Set Hot Spare Protection Policy............................................................................... 186
Omconfig Connector Commands...................................................................................................186
Omconfig Rescan Connector.....................................................................................................186
Omconfig Cachecade Commands.................................................................................................. 187
Omconfig Blink Cachecade........................................................................................................187
Omconfig Unblink Cachecade................................................................................................... 187
Omconfig Delete Cachecade.....................................................................................................188
Omconfig Resize Cachecade..................................................................................................... 188
Omconfig Rename Cachecade..................................................................................................188
Omconfig PCIe SSD Commands......................................................................................................189
omconfig Add PCIe SSD Device To Cachepool........................................................................ 189
Omconfig Add PCIe SSD Device To Cachepool........................................................................189
Omconfig Reactivate PCIe SSD Device......................................................................................189
Omconfig Fluid Cache Commands................................................................................................. 190
Omconfig Applying Or Updating License To The Fluid Cache.................................................190
Omconfig Conecting To The Fluid Cache.................................................................................190
Omconfig Partition Command.........................................................................................................190
Omconfig Refreshing Partition List............................................................................................ 190
Omconfig Fluid Cache Disk Command............................................................................................191
Omconfig Discarding Data And Disabling Caching................................................................... 191
9 Working With CLI Command Results..............................................................193
Output Options For Command Results........................................................................................... 193
Controlling Command Output Display............................................................................................ 193
Writing Command Output To A File.................................................................................................194
Saving Command Results To A File That Is Overwritten........................................................... 194
Append Command Results To An Existing File.......................................................................... 195
Selecting A Format For The CLI Command Output........................................................................ 196
List (lst).........................................................................................................................................196
Table (tbl)..................................................................................................................................... 197
Semicolon-Separated Values (ssv)..............................................................................................197
Custom Delimited Format (cdv)................................................................................................. 198
10
1

Introduction

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 manage their entire network by providing a 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. 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.
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: The CLI does not use the Server Administrator Web server. For concerns on encryption, from the CLI, run the omconfig system webserver action=stop command to turn off the Web server. The Web server starts automatically after a reboot, so you must run this command each time the system is rebooted. . For more information, see omconfig system webserver or omconfig servermodule
webserver.
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 terms used in this document, see the Glossary at dell.com/support/ manuals.

What's New In This Release

The release highlights of OpenManage Server Administrator are:
Added support for the following operating system:
– Microsoft Windows Server 2012 R2 Datacenter, Foundation, Essentials, and Standard editions
– Novell SUSE Linux Enterprise Server 11 SP3 (64–bit)
– Red Hat Enterprise Linux 6.5 (64–bit)
– VMware ESXi 5.0 U3 and ESXi 5.1 U2
11
– VMware vSphere 5.5
Added support for the following browsers:
– Mozilla Firefox 22 and 23
– Internet Explorer 11
– Safari 6.0
– Google Chrome 27, 28, and 30
Support for a new license format for Citrix XenServer 6.1.
Added support for the following Adapter cards:
– Mellanox ConnectX-3 Dual Port 40 GbE QSFP+ Network Adapter
– Mellanox ConnectX-3 Dual Port 10 GbE DA/SFP+ Network Adapter
– Mellanox ConnectX-3 Dual Port 10 GbE KR Blade Mezzanine Card
– Emulex OCe14102-UX-D Dual Port 10Gb SFP+ CNA
– Emulex OCm14102-U3-D Dual Port 10Gb KR Blade Mezz
– Emulex OCm14102-U2-D Dual Port 10Gb KR Blade NDC
– Emulex OCm14104-UX-D Quad Port 10Gb DA/SFP+ Rack NDC
Added support for Dell PERC 9 controllers (H730P Adapter) on R920 with the following features:
– RAID 10 virtual disk with uneven span.
– Advanced 4K sector hard disk drives.
– T10 Protection Information (PI) for data integrity.
NOTE: For more information, see the Server Administrator Storage Management guide at dell.com/openmanagemanuals.
Support for displaying and setting the JRE version. See Omreport Preferences Commands and
Omconfig Preferences Webserver.
Support for displaying Node Id in System/Server Module Summary information. See omreport system
summary or omreport servermodule summary.
Support for new values for form factor aligning to iDRAC values. See omreport system summary or
omreport servermodule summary.
Added support for Software RAID controllers (PERC S110) on systems running the Windows Server
2012 R2 operating system.
Added support for Non-Volatile Memory Express (NVMe) Peripheral Component Interconnect Express
(PCIe) solid-state drives (SSDs). See the Server Administrator Storage Management guide at dell.com/
openmanagemanuals.
NOTE: Dell PowerEdge Express Flash NVMe PCIe SSD devices support only the Dell-provided Windows Server 2012 R2 (64–bit) drivers.
Added support for the following LSI Serial Attached SCSI (SAS) Host Bus Adapters (HBAs) on supported
12G systems:
– LSI SAS 9207–8e
– LSI SAS 9300–8e
– LSI SAS 9206–16e
Added support for the following Dell PowerEdge servers:
– R920
– R220
12
– M820VRTX
Deprecated support for the following operating systems:
– SUSE Linux Enterprise Server 10 SP4
– SUSE Linux Enterprise Server 11 SP2
– Red Hat Enterprise Linux 6.4 (64–bit)
– VMware ESXi 5.1 U1 HDD and Flash
– VMware ESXi 5.0 U2 HDD and Flash
NOTE: For the list of supported operating systems and Dell servers, see the Dell Systems Software Support Matrix in the required version of OpenManage Software at dell.com/openmanagemanuals.
NOTE: CLI commands are not supported on systems running the VMware ESXi operating system.

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 StartProgramsAccessoriesCommand Prompt.
Click StartRun and type cmd.exe.
NOTE: Do not type command in the Run dialog box to launch a command line window; this activates the MS-DOS emulator can cause subtle problems with CLI.
command.com, which has environment variable limitations that

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 actions 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.
13
NOTE: For an overall summary of the CLI commands, type omhelp.
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 command. For more information on the corresponding CLI syntax, see the Dell Update Packages
for Operating Systems User’s Guide
dell.com/support/manuals.
Related Links: Working With CLI Command Results
or the Dell OpenManage Server Update Utility User’s Guide at
<package name> /s [/f

CLI Error Checking And Error Messages

When you type CLI commands, the CLI checks these commands for the 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 type a successful omconfig command, data for that component is displayed. The following omconfig command examples displays valid CLI commands and their success messages:
Table 1. Commands And Messages
Command Message
omconfig chassis temps index=0 warnthresh= default
omconfig chassis biossetup attribute=numlock setting=on
omconfig system assetinfo info=depreciation 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.
Temperature probe warning threshold value(s) set successfully.
BIOS setup configured successfully. Change will take effect after the next reboot.
omconfig system assetinfo info=depreciation duration=6

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.
The following are examples of some failure messages:
14
Command
omconfig chassis volts index=3 minwarnthresh=3.3000
Message
Revised command
When you type the revised command with three decimal points, you receive another error message:
Message
Revised command
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.
omconfig chassis volts index=3 minwarnthresh=3.300
Error! This voltage probe min warning threshold must be between 11.400 and 12.480.
omconfig chassis volts index=3 minwarnthresh=11.500
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 specifies the warning thresholds for each major component of a system and also specifies a set of actions that the administrator wants each system to take in case of a warning or failure event. In 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 re-configuration.
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 are executed, 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.
15
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.
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
In this example, 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=<n> waybill=<n> installdate=<mmddyy> purchasedate=<mmddyy> ponum=<n> signauth=<text> expensed=<
In each chapter of this document, command syntax and other information about the commands are formatted using any of the following fields as appropriate:
yes>|no> costcenter=<text>
command level 1 command level 2 command level 3 name=value pair 1 name=value pair 2
16
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 -?, the CLI help lists all the subcommands available for omconfig
:
system
alertaction
alertlog
assetinfo
cmdlog
esmlog
events
platformevents
pedestinations
recovery
shutdown
thrmshutdown
webserver
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
17
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.
For one info value, specify one or more optional parameter(s). The following table displays the optional parameters for info=acquisition:
Table 2. 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>
18
3

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.
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. The following table lists the systems on which the omreport commands are applicable:
Table 3. System Availability For The omreport Command
Command Level 1
omreport modularenclos
Command Level 2
ure
servermodule Blade systems
mainsystem Blade systems
system Rack and Tower systems
chassis Rack and Tower systems
preferences Blade or Rack, and Tower systems
Applicable To
Blade systems

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 you can enable or disable the component or feature, but you cannot simultaneously enable and disable the component or feature.
19

Command Summary Of The omreport Command

Depending 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 Enterprise Linux systems, the 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.
The following table provides a high-level summary of the omreport command. The column titled Command level 1 displays 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.
The following table lists the omreport commands available for about, system, and main system chassis.
Table 4. Command Level 1, Level 2, And Level 3 For omreport
Command Level 1
omreport modularenclosu
Command Level 2Command
re
about U, P, A Displays the version number and
chassis or mainsystem
Level 3
details=true U, P, A Displays the information for all the Server
acswitch U, P, A Displays the failover settings where
batteries U, P, A Displays the properties set for batteries.
bios U, P, A Displays the BIOS information such as
biossetup A Displays the BIOS setup properties
fans U, P, A Displays the status and thresholds for
User Privilege Required
U, P, A Displays the information for all the
U, P, A Displays the general status of all the main
Use
modular chassis.
properties for Server Administrator.
Administrator programs installed.
components.
redundant AC power lines are supported in a system.
manufacturer, version, and release date.
configured during system boot.
system fans.
20
firmware U, P, A Displays the name and version of the
firmware.
frontpanel U, P, A Displays whether the front panel button
settings, such as the Power button and/or
Command Level 1
Command Level 2Command
Level 3
fru U, P, A Displays the Field Replaceable Unit (FRU)
hwperformanceU, P, A Displays the status and cause for the
info U, P, A Displays a status summary for main system
intrusion U, P, A Displays the status of the system’s
leds U, P, A Displays the properties you have set for
memory U, P, A Displays properties of the system's
User Privilege Required
Use
Nonmasking Interrupt (NMI) button (if present on the system), are enabled or disabled. It also displays the front panel encryption access information and the front panel LCD information.
information.
system’s performance degradation.
chassis components.
intrusion sensor(s).
light-emitting diodes to flash under various alert conditions.
memory arrays.
nics U, P, A Displays the NIC and Team interface
properties.
ports U, P, A Displays the properties for the system’s
parallel and serial ports, such as I/O address, IRQ level, connector type, and maximum speed.
processors U, P, A Displays properties of the system’s
processors, including speed, manufacturer, and processor family.
pwrmanagem ent
pwrmonitoringU, P, A Displays properties of power consumption.
pwrsupplies U, P, A Displays the properties of power supplies.
remoteaccess U, P, A Displays general information on remote
slots U, P, A Displays the properties of the system’s
temps U, P, A Displays the status and thresholds for the
U, P, A Displays power inventory details such as
system idle power, system maximum potential power, and power budget information.
access.
expansion slots and other slot types.
system temperature sensors.
21
Command Level 1
Command Level 2Command
Level 3
volts U, P, A Displays the status and thresholds for the
User Privilege Required
Use
system voltage sensors.
removableflas hmedia
licenses U, P, A Displays the digital licenses of the installed
storage U, P, A See Using The Storage Management
system or servermodule
alertaction U, P, A Displays the warning and failure threshold
alertlog U, P, A Allows the administrator to display the
assetinfo U, P, A Displays the cost of ownership information
cmdlog U, P, A Allows the administrator to display the
esmlog U, P, A Allows the administrator to display the
U, P, A Displays the system’s virtual flash (vFlash)
and secure digital (SD) card details.
hardware devices of the system.
Service.
U, P, A Displays a high-level summary of system
components.
values, as well as actions configured when an essential component detects a warning or failure state.
alert log.
for the system.
command log.
hardware log.
22
events U, P, A Displays the system’s Simple Network
Management Protocol (SNMP) event settings.
operatingsystemU, P, A Displays the name and version of the
operating system.
pedestinationsU, P, A Displays the destinations to send the
configured alerts for platform events.
platformeventsU, P, A Displays the system’s response for each
listed platform event
recovery P, A Displays how the system is configured to
respond to a hung operating system.
shutdown P, A Displays how to perform the shutdown
action.
summary U, P, A Displays the key facts for all system
components, including main system chassis, software, and storage.
Command Level 1
Related Links: omreport: Viewing System Status Using The Instrumentation Service
Command Level 2Command
Level 3
thrmshutdownP, A Displays how to perform the shutdown
version U, P, A Displays a summary for all updatable
preferences webserver U, P, A Displays the URL information of the Server
messages A Displays the configured alert message
User Privilege Required
Use
action, if any, when a temperature warning or failure condition is detected.
components on the system.
Administrator Web server.
format.

Help With The omreport Command

Use the omreport -? command to get a list of the available commands for omreport. Use omreport <command level 2> -? to get help on the level 2 about, chassis, and system commands.
The following information on omreport system -? also applies to get help for the omreport chassis command.
To see a list of valid commands for omreport system, type:
omreport system -? | more

omreport modularenclosure

Use the omreport modularenclosure command to view details of the Blade system. Type:
omreport modularenclosure
NOTE: This CLI command is available when Dell OpenManage Server Administrator is installed on Dell Blade systems.
Server Administrator displays information related to the modular enclosure and chassis management controller CMC (if available):
NOTE: The output varies depending on the configuration of the system.
Modular Chassis Information
Chassis Information
Attribute : Model
Value : Modular Server Enclosure
Attribute : Lock
Value : true
Attribute : Service Tag
Value : 8RLNB1S
23
Attribute : Express Service Code
Value : 18955029124
CMC Information
Attribute : Product
Value : Chassis Management Controller (CMC)
Attribute : Description
Value : The system component provides a complete set
of remote managementfunctions for Dell systems.
Attribute : Version
Value : 3.20
Attribute : IP Address
Value : 101.102.103.104
Attribute : IP Address Source
Value : Dynamic Source
Attribute : IP Address Type
Value : IPv4
Attribute : Remote Connect Interface
Value : Launch CMC Web Interface

omreport about

Use the omreport about command to learn the product name and version number of the systems management application installed on the system. The following is an example output from the omreport about command:
Product name : Dell OpenManage Server Administrator
Version : x.x.x
Copyright : Copyright (C) Dell Inc. xxxx-xxxx. All rights
reserved.
Company : Dell Inc.
For details about the environment for Server Administrator, type:
omreport about details=true
Server Administrator includes a number of services, each of which has a version number of its own. The Contains field reports version numbers for the services as well as other useful details. The following output is an example, and can change depending on the system’s configuration and the version of Server Administrator installed on the system:
24
Contains:
Instrumentation Service 7.x.x Storage Management 4.x.x Sun Java Runtime Environment 1.x.x_xx Secure Port Server 7.x.x Server Administrator Core Files 7.x.x Instrumentation Service Integration Layer 7.x.x Server Administrator Common Framework 7.x.x Common Storage Module 4.x.x Data Engine 7.x.x Instrumentation Service 7.x.x

Omreport Chassis Or Omreport Mainsystem Commands

Use the omreport chassis or omreport mainsystem commands to view details for the entire chassis or for a particular component. Type:
omreport chassis
or
omreport mainsystem
Server Administrator displays a general status for the main system chassis or main system components.
Health
Main System Chassis
SEVERITY : COMPONENT
Ok : Fans
Critical : Intrusion
Ok : Memory
Ok : Power Supplies
Ok : Temperatures
Ok : Voltages

Omreport Chassis Acswitch Or Omreport Mainsystem Acswitch

Use the omreport chassis acswitch or omreport mainsystem acswitch command if the system has redundant AC power lines that are configured in a failover arrangement. Type:
omreport chassis acswitch
or
omreport mainsystem acswitch
Server Administrator displays the following output:
AC Failover Switch
AC Switch Redundancy
25
Redundancy Status : Full
Number of devices required for full redundancy
Redundancy Mode :
Redundancy Configuration : Input Source Line 1, upon redundancy
AC Power Lines
Status : Ok
Location : AC Power Line 1
AC Present : Power Present
Active Source : Active
Status : Ok
Location : AC Power Line 2
AC Present : Power Present
Active Source : Not Active
Server Administrator reports values for the Redundancy Status and Redundancy Mode fields.
: 2
restoration, return to Line 1

Omreport Chassis Batteries Or Omreport Mainsystem Batteries

Use the omreport chassis batteries or omreport mainsystem batteries command to view battery properties. Type:
omreport chassis batteries
or
omreport mainsystem batteries

Omreport Chassis Bios Or Omreport Mainsystem Bios

Use the omreport chassis bios or omreport mainsystem bios command to view the current BIOS information. Type:
omreport chassis bios
or
omreport mainsystem bios
Server Administrator displays the summary of the BIOS information for the system.

Omreport Chassis Biossetup Or Omreport Mainsystem Biossetup

Use the omreport chassis biossetup or omreport mainsystem biossetup command to view BIOS setup parameters that are normally available only during system boot. Type:
omreport chassis biossetup
or
omreport mainsystem biossetup
26
NOTE: To maintain consistency across the commands, the output format of this command has changed. Change the user scripts as applicable.
To view the BIOS Setup parameters in short form, type:
omreport chassis biossetup display=shortnames
To view all available boot devices, alias names, and boot order sequences, type:
omreport chassis biossetup attribute=bootorder
NOTE: The bootorder attribute is applicable only on systems prior to 12G. To list the device boot order, type
Boot Settings
NOTE: On Linux systems, user or user groups upgraded to administrator or administrator groups cannot view the boot order sequence.
omreport chassis biossetup and serach the list under BIOS Boot Settings or UEFI
depending on the BIOS boot setting.

BIOS Setup Parameters On Systems Prior To PowerEdge 12G Systems

The following table displays the available BIOS setup parameters on systems prior to PowerEdge 12G systems.
NOTE: All the BIOS Setup parameters are not displayed. Only those BIOS setup properties configured during system boot are displayed.
Table 5. BIOS Setup Parameters On Systems Prior To Dell PowerEdge 12G Systems
Parameter Description
Bootsequence Displays the device used to boot the system.
Numlock Displays whether the keypad is used as number keys.
Embedded Video Controller
Boot Mode Displays whether the boot mode is configured to BIOS or Unified
Processor C1-E Displays the Processor C1-E status.
CPU Execute Disable Displays whether the Execute Disable (XD) option is enabled or disabled.
Processor C State Control Displays whether the Processor C State Control option is enabled or
Processor CMP Displays the number of cores enabled per processor.
User accessible USB Ports Displays whether the user-accessible USB port is enabled or disabled.
CPU Virtualization Technology
AC Power Recovery Mode Displays the system state when input power is restored after an outage.
Embedded SATA Controller Displays whether the embedded SATA controller is set to ATA mode, RAID
SATA Port 0 Displays the state of SATA port 0.
Displays whether the Embedded Video Controller option is enabled or disabled.
Extensible Firmware Interface (UEFI).
disabled.
Displays the additional hardware capabilities provided by Virtualization Technology.
mode, or is disabled.
SATA Port 1 Displays the state of SATA port 1.
27
Parameter Description
Dual NIC (1/2) Displays whether NIC 1 and NIC 2 with PXE/iSCSI is enabled or disabled.
Dual NIC (3/4) Displays whether NIC 3 and NIC 4 with PXE/iSCSI is enabled or disabled.
NIC 1 Displays whether the first NIC is enabled (with or without PXE/iSCSI) or
disabled during system boot.
NIC 2 Displays whether the second NIC is enabled (with or without PXE/iSCSI) or
disabled during system boot.
NIC 3 Displays whether the third NIC is enabled (with or without PXE/iSCSI) or
disabled during system boot.
NIC 4 Displays whether the fourth NIC is enabled (with or without PXE/iSCSI) or
disabled during system boot.
Trusted Cryptographic Module (TCM)
Trusted Platform Module (TPM) Security
Internal USB Port (number) Displays whether the internal USB is enabled or disabled.
Operating System Watchdog Timer
HT Assist Displays the status of the probe filter chipset option.
Internal SD Card Displays whether the internal SD card is enabled or disabled.
Bezel Displays whether the bezel removal intrusion check during system reboot
Console Redirection Displays whether the BIOS screen is redirected over a particular serial port
Diskette Displays whether the diskette is disabled, auto enabled, or read-only.
Demand Based Power Management (DBS)
Embedded Hypervisor Displays whether the embedded hypervisor is enabled or disabled.
Displays whether TCM is on or off.
Displays whether TPM is off, on with pre-boot measurements, or on without pre-boot measurements.
NOTE: Server Administrator may not display the USB sequence number if there is only one USB port on the system.
Displays whether the operating system watchdog timer is enabled or disabled.
is enabled or disabled.
or if it is turned off.
Displays whether DBS is enabled or disabled on the system.
IDE Displays whether the drive is enabled or disabled.
IDE Primary Drive 0 Displays whether the device is automatically detected and enabled or if the
device is disabled.
IDE Primary Drive 1 Displays whether the device is automatically detected and enabled or if the
device is disabled.
Intrusion Displays whether the intrusion check is enabled or disabled during system
boot.
Mouse Displays whether the mouse is enabled or disabled.
28
Parameter Description
Optical Drive Controller Displays whether the optical drive controller is enabled or disabled.
Parallel port address Displays whether the address is located on LPT1, LPT2, and LPT3, or if it is
disabled.
Parallel port mode Displays the setting associated with the parallel port.
Primary SCSI Displays whether the device is on or off.
RAID on motherboard Displays whether RAID-on-motherboard is detected as a RAID device, a
SCSI device, or if the device is disabled during system boot.
RAID Channel A Displays whether RAID-on-motherboard Channel A is detected as a RAID
device or a SCSI device.
RAID Channel B Displays whether RAID-on-motherboard Channel B is detected as a RAID
device or a SCSI device.
Serial Port 1 Displays whether serial port 1 is mapped to a COM port, COM port 1, COM
port 3, COM1 BMC, BMC Serial, BMC NIC, BMC RAC, or is disabled.
Serial Port 2 Displays whether serial port 2 is mapped to a COM port, COM port 2, COM
port 4, or is disabled.
Speaker Displays whether the speaker is on or off.
USB or USBB Displays whether the USB port is enabled or disabled.
Secondary SCSI Displays whether the device is enabled or disabled.
Serial Communications Displays whether COM port 1 and COM port 2 are off or on with or without
console redirection.
Console Redirection After Boot
External Serial Connector Displays whether the external serial connector is mapped to Serial Device
Console Redirection Failsafe Baud Rate
Serial Address Select Displays port address for the serial devices.
Displays whether console redirection after system reboot is enabled or disabled.
1, Serial Device 2, or a Remote Access Device.
Displays the setting for console redirection failsafe baud rate.

BIOS Setup Groups On PowerEdge yx2x Systems

The following table lists the available groups of the BIOS setup parameters on PowerEdge yx2x systems.
NOTE: Based on the hardware configuration, the attributes may vary in a specific group.
Table 6. BIOS Setup Groups On PowerEdge yx2x Systems
Group Description
BIOS Boot Settings Controls the system boot settings when bootmode is set to bios.
Boot Settings Controls the system boot settings when bootmode is set to bios.
29
Group Description
Embedded Server Management
Integrated Devices Controls the devices integrated on the system board.
Memory Settings Controls the system memory settings.
Miscellaneous Settings Controls some miscellaneous system settings.
One-Time Boot Supports one-time boot to a specified device.
Processor Settings Controls the processor(s) settings of the system.
SATA Settings Control the embedded SATA ports settings.
Serial Communication Controls the Serial Communication options.
Slot Disablement Controls the system slots that are present on the system.
System Information Displays the information that uniquely identifies the system.
System Profile Settings Controls the power management settings.
System Security Controls the security features of the system.
UEFI Boot Settings Controls the system boot settings when boot mode is set to uefi.
Sets up the Embedded Server Management options.

Omreport Chassis Currents Or Omreport Mainsystem Currents

This command is no longer available through Server Administrator.

Omreport Chassis Fans Or Omreport Mainsystem Fans

Use the omreport chassis fans or omreport mainsystem fans command to view the fan probe status and settings. Type:
omreport chassis fans index=n
or
omreport mainsystem fans index=n
The index parameter is optional. If you do not specify the index, Server Administrator displays a summary of status, readings, and thresholds set for any fan probes that are present on the system. If you specify the index, Server Administrator displays a summary for a specific fan probe.

Omreport Chassis Firmware Or Omreport Mainsystem Firmware

Use the omreport chassis firmware or omreport mainsystem firmware command to view current firmware properties. When you type:
omreport chassis firmware
or
omreport mainsystem firmware
Server Administrator displays a summary of the system’s firmware properties.
30
Loading...
+ 168 hidden pages