Manuals

Manuals
Introduction: Dell OpenManage Server Administrator Version 5.2 Command Line Interface User's Guide

Back to Contents Page

Introduction

Dell™ OpenManage™ Server Administrator Version 5.2 Command Line Interface User's Guide

  What's New for Version 5.2

  Using CLI Commands from Windows Command Prompts

  Primary CLI Commands

  CLI Error Checking and Error Messages

  Scripting and Comparing With the CLI

  Command Syntax Overview


Whether you are using the graphical user interface (GUI) or the command line interface (CLI), Dell OpenManage Server Administrator performs essential systems management tasks.

The reporting and viewing features allow retrieval of overall health status for systems on your network. At the component level, you can view information about the voltages, temperatures, current, fan RPM, memory functioning, and many other critical component details. You see a detailed account of many relevant cost of ownership (COO) facts about your system in summary view. Version information for BIOS, firmware, operating system, and all installed software is easy to retrieve.

Configuration features allow the Server Administrator to perform essential tasks described in detail in the following sections.

NOTE: You can use the CLI instead of the Server Administrator home page, and turn the Server Administrator Web server off if you have security concerns. The CLI does not use the Web server. Use the omconfig system webserver action=stop command to turn off the Web server. The Web server starts automatically after a reboot, so this command must be issued every time a system starts up. See "omconfig system webserver" for more information.

What's New for Version 5.2

  • Added support for Dell PowerEdge 2970 system

  • Added support for Microsoft® Windows Server® 2003 family (x86) (SP2 with Web, Standard, and Enterprise editions)

  • Added support for Microsoft Windows Server 2003 family (x86_64) (SP2 with Standard, and Enterprise editions)

  • Added support for Microsoft Windows® Unified Data Storage Server 2003 (x86_64)

  • Added support for Microsoft Windows Server 2003 R2, Datacenter x64 Edition

  • Added support for Red Hat® Enterprise Linux® Version 5 (x86) and (x86_64) systems

  • Added support for NIS, Kerberos, LDAP, and Winbind authentication protocols for Linux operating systems

  • Added information on features of Intel® and AMD processors in the Processor Information page

  • Added a new command in Storage Management: importrecoverforeignconfig

  • Added a new omconfig preferences snmp setting command to configure SNMP Set Operations

NOTE: SNMP Set Operations are disabled by default in Server Administrator.

Using CLI Commands from Windows Command Prompts

If you are running the Windows operating system, use the 32-bit command prompt to issue a Server Administrator CLI command. You can access the 32-bit command prompt by clicking the Start button and pointing to Programs® Accessories® Command Prompt shortcut, or by clicking the Start button and selecting Run, then typing cmd.exe in the Run dialog box.

Do not type command into the Run dialog box to launch a command line window; this activates the MS-DOS® emulator command.com, which has environment variable limitations that can cause subtle problems with the CLI.


Primary CLI Commands

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

    • omconfig

    • omhelp

    • omreport

The omconfig command writes values that you assign to an object's properties. You can specify values for warning thresholds on components or prescribe what action your system is to take when a certain warning or failure event occurs. You can also use the omconfig command to assign specific values to your system's asset information parameters, such as the purchase price of the system, the system's asset tag, or the system's location.

The omhelp command displays short text help for CLI commands. The shorthand equivalent of omhelp is the command for which you want help followed by -?. For example, to display help for the omreport command, type one of the following commands:

omhelp omreport

omreport -?

The omreport command produces reports of your system's management information.

NOTE: For an overall summary of CLI commands, type omhelp.

Table 1-1 lists the primary CLI commands used by Server Administrator. This guide contains a section for each primary command.

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

Primary CLI Command

Section Title

Related Sections

omconfig

omconfig: Managing Components Using the Instrumentation Service

omconfig system assetinfo: Editing Cost of Ownership Values

omhelp

omhelp: Getting Help With CLI Commands

 

omreport

omreport: Viewing System Status Using the Instrumentation Service

omreport rac: Viewing Remote Access Controller Components

NOTE: omupdate commands are no longer supported in Server Administrator and are replaced by Dell Update Package or Server Update Utility commands. To update the different components, download the Dell Update Package and run <package name> /s [/f]. See the Dell Update Packages for Microsoft Windows Operating Systems User's Guide, the Dell Update Packages for Red Hat Enterprise Linux User's Guide, or the Server Update Utility User's Guide for more information on corresponding CLI syntax.

Additional useful topics about the CLI include:


CLI Error Checking and Error Messages

The CLI checks your commands for correct syntax when you enter them. If you enter a command and the command is executed successfully, a message displays, stating that your command has been successful.

Success Messages

For a successful omreport command, data about the component displays. When data for the component displays, your command is successful.

The following omconfig command examples show valid CLI commands and their success messages:

Command:

omconfig chassis temps index=0 warnthresh=default

Message:

Temperature probe warning threshold value(s) set successfully.

Command:

omconfig chassis biossetup attribute=speaker setting=on

Message:

BIOS setup configured successfully.

Command:

omconfig system assetinfo info=depreciation duration=6

Message:

Asset information set successfully.

Failure Messages

CLI failure messages provide reasons why some commands do not succeed. Some common reasons why commands fail include syntax errors and components that are not present. Many error messages provide syntax information that you can use to execute the command successfully.

If you try to execute a command for a component or feature that is not present in your system configuration, the error message states that the component is not present.

Command:

omreport chassis currents

Example message:

Error! No current probes found on this system.

Command:

omconfig chassis volts index=3 minwarnthresh=3.3000

Example message:

Error! Number with up to 3 digits after decimal point expected, read 3.3000

The value given by the command specifies more than 3 digits after the decimal point. A valid minimum warning threshold value for volts contains up to 3 digits after the decimal point.

Type:

omconfig chassis volts index=3 minwarnthresh=3.300

When you enter the revised command with three decimal points, you receive another error message:

Error! This voltage probe min warning threshold must be between 11.400 and 12.480.

Revised command:

omconfig chassis volts index=3 minwarnthresh=11.500

Message:

Voltage probe warning threshold(s) set successfully.


Scripting and Comparing With the CLI

The Server Administrator CLI allows administrators to write batch programs or scripts to be executed by the operating system. For an enterprise with many systems, an administrator could write a configuration script that specified the warning thresholds for each major component of a system and also specified a set of actions that the administrator wants each system to take in case of a warning or failure event. In the most critical cases, the administrator could write a script so that the system shuts down to prevent damage. The administrator could then distribute and execute the script to many managed systems at the same time. Such a scenario facilitates configuring any number of new systems acquired by a company and makes implementation of new system administration policies easier across many existing systems that require reconfiguration.

A similar scenario could be used to populate a large number of newly acquired systems with detailed asset information. Much of the information would be the same, such as the manufacturer or lessor of the system, whether support for the system is outsourced, name of the system's insurance company, method of depreciation, and so on. Any variable that is common to all systems could be scripted, sent to all managed systems, and executed. Asset information that is unique to a system could be scripted as a group and sent to that managed node for execution. For example, a script could specify values for all unique variables such as owner, primary user phone number, asset tag, and so on. Scripts to populate unique values would set all unique variables at once rather than one by one through the system's command line.

In many cases, the CLI allows a user with a very well-defined task in mind to retrieve information about the system rapidly. If a user wants to review a comprehensive summary of all system components and save that summary information to a file for comparison with later system states, the CLI is ideal.

Using CLI commands, administrators can write batch programs or scripts to execute at specific times. When these programs execute, they can capture reports on components of interest, such as fan RPMs during periods of high system usage compared with the same measurements at times of lowest system usage. Command results can be routed to a file for later analysis. Reports can help administrators gain information that can be used to adjust usage patterns, to justify purchasing new system resources, or to focus on the health of a problem component.


Command Syntax Overview

Commands vary in complexity. The simplest command has only command level 1. The omhelp command is a simple command. When you type omhelp, a list of the main CLI commands is displayed.

The next level of complexity includes commands that contain command levels 1 and 2. All of the about commands are examples of command level 2 complexity. The omconfig about and omreport about commands cause a very brief summary to display. The summary shows version information for the systems management software installed on your system; for example, Server Administrator 1.x.

Some commands have command level 1 and command level 2 and one name=value pair. Consider the following example command that instructs Server Administrator for more details about the environment for Server Administrator:

omreport about details=true

Command level 1 is omreport, command level 2 is about, and the name=value pair is
details=true.

Many commands use command level 1, command level 2, and command level 3, but do not require any parameters (name=value pairs). Most omreport commands are of this type. For example:

omreport system alertaction

causes a list of alert actions that are configured for components on your system to be displayed.

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

omconfig system assetinfo info=depreciation duration=3

An example of nine name=value pairs:

omconfig system assetinfo info=acquisition
purchasecost=<n> waybill=<n> installdate=<mmddyy> purchasedate=<mmddyy> ponum=<n> signauth=<text>
expensed=<yes | no> costcenter=<text>

In each section, command syntax and other information about commands is formatted with any of the following fields that apply:

command level 1

command level 2

command level 3

name=value pair 1

name=value pair 2


Back to Contents Page

 

Laptops | Desktops | Business Laptops | Business Desktops | Workstations | Servers | Storage | Monitors | Printers | LCD TVs | Electronics
© 2009 Dell | About Dell | Terms of Sale | Unresolved Issues | Privacy | About Our Ads | Dell Recycling | Contact | Site Map | Feedback
AT | AU | BE | BR | CA | CH | CL | CN | CO | DE | DK | ES | FR | HK | IE | IN | IT | JP | KR | ME | MX | MY | NL | NO | PA | PR | RU | SE | SG | UK | VE | ALL

snEB15