Dell OpenManage Server Administrator Version 6.1 CIM Reference Guide

Dell™ OpenManage™

Server

Administrator Version 6.1

CIM Reference Guide

www.dell.com | support.dell.com

Notes

NOTE: A NOTE indicates important information that helps you make better use of

your computer.

____________________

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

Trademarks used in this text: Dell, the DELL logo, OpenManage are trademarks of Dell Inc.; Microsoft and Windows NT are either trademarks or registered trademarks of Microsoft Corporation in the United States and/or other countries; Intel, Pentium, Xeon, Itanium, i860, i960, and Celeron are registered trademarks and MMX, i386, i486, SpeedStep, and Cor e are trademarks of Intel States and/or other countries; AMD, AMD Phenom and Turion are trademarks and AMD-K6 -2 and AMD-K6 -III are registered trademarks of Advanced Micro Devices, Inc. in the United States and/or other countries; Crusoe and Efficeon are trademarks of Transmeta Corporation in the United States and/or other countries.

Other trademarks and trade names may be used in this document to refer to either the entities claiming the marks and names or their products. Dell Inc. disclaims any proprietary interest in trademarks and trade names other than its own.

April 2009

Athlon, AMD Dur on, AMD-K5, AMD-K6, Opter on, Sempr on,

Corporation in the United

Contents

1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . 9

Server Administrator . . . . . . . . . . . . . . . . . . . 9

Documenting CIM Classes and Their Properties

Common Properties of Classes . . . . . . . . . . . . . 13

. . . . . . . . . . . . . . . . . . . . . 10

Base Classes . . . . . . . . . . . . . . . . . . . . 11

Parent Classes . . . . . . . . . . . . . . . . . . . 12

Classes That Describe Relationships . . . . . . . 12

Dell-Defined Classes . . . . . . . . . . . . . . . . 13

Introduction

This reference guide documents the Dell™ OpenManage™ Server Administrator Common Information Model (CIM) provider contained in the Management Object File (MOF) dccim32.mof.

CIM provides a conceptual model for describing manageable objects in a systems management environment. CIM is a modeling tool rather than a programming language. CIM provides the structure for organizing objects into a model of a managed environment. For modeling a managed environment, CIM makes available a set of abstract and concrete classes of objects. These classes model the basic characteristics of systems, networks, and applications, as well as groupings of management-related data.

For more information about CIM, see the Distributed Management Task Force (DMTF) website at www.dmtf.org and the Microsoft www.microsoft.com.

Server Administrator

Server Administrator 1.0 or later provides a suite of systems management information for keeping track of your networked systems. In addition to providing systems management agents that are independent of the management console, Server Administrator supports these systems management standards: CIM and Simple Network Management Protocol (SNMP).

In addition to supporting systems management industry standards, Server Administrator provides additional systems management information about the specific components of your Dell™ system.

website at

Introduction 9

What’s New in this Release

These are the changes made to this guide:

• Added the classes

DCIM_RegisteredProfile

• Added the

DELL_Chassis

DCIM_OEM_DataAccessModule

CIM_Processor

EsmLogStatus

class.

family update.

and

MemoryRedStatus

and

attributes to the

Documenting CIM Classes and Their Properties

The Dell CIM provider extends support to Dell-specific software and hardware components. The provider. All of the supported classes and properties in the MOF are documented in this guide.

The following subsections define some of the basic building blocks of CIM

classes that are used in describing the dccim32 provider name.

These

subsections also explain how the elements used in describing

classes are organized. This section does not document the entire

these CIM

schema, but only those classes and properties supported by the

dccim32

The property values being presented could be NULL or empty string on some systems, although in general, some non-empty values can be expected. Key properties (listed below) will always carry non-empty values. It is recommended that you use only the following properties as key attributes:

•

provider. The list of properties for each supported class varies greatly.

CIM_PhysicalElement

CIM_System

CIM_LogicalDevice

CreationClassName, DeviceID

CIM_Dependency

CIM_SoftwareElement

SoftwareElementID, TargetOperatingSystem

CIM_SoftwareFeature

Version, Name

: CreationClassName, Name

Dell MOF defines the classes for the Dell CIM

: CreationClassName, Tag

: SystemCreationClassName, SystemName,

: Antecedent, Dependent

: Name, Version, SoftwareElementState,

: IdentifyingNumber, ProductName, Vendor,

10 Introduction

•

CIM_IRQ

IRQNumber

•

CIM_MemoryMappedIO

CreationClassName, StartingAddress

•

CIM_DMA

DMAChannel

•

CIM_RedundancyGroup

•

DELL_EsmLog

•

DELL_PostLog

•

DELL_BIOSExtensions

•

DELL_BIOSSettings

•

CIM_ServiceAccessPoint

SystemName, CreationClassName, Name

: CSCreationClassName, CSName, CreationClassName,

: CSCreationClassName, CSName,

: CSCreationClassName, CSName, CreationClassName,

: CreationClassName, Name

: RecordNumber

: systemBIOSCharacteristics

: DisplayName

: SystemCreationClassName,

Base Classes

The classes listed in the Server Administrator CIM provider class hierarchy do

not have a parent property. These base classes do not derive from

another

class. The base classes are:

•

CIM_ManagedSystemElement

•

CIM_Dependency

•

DELL_EsmLog

•

DELL_PostLog

•

DELL_CMApplication

•

DELL_CMDevice

•

DELL_CMDeviceApplications

Introduction 11

•

DELL_CMInventory

•

DELL_CMOS

•

DELL_CMProductInfo

The CIM_ManagedSystemElement class is the base class for the system element CIM_ManagedSystemElement has no parent. Examples of managed system elements include software components such as files, devices such as hard drives and controllers, and physical subcomponents of devices such as chip sets and Caption, CreationClassName, Description, Name, and Status in Ta b l e 1-1

The Dell-defined classes are not defined in the official schema by the DMTF, the industry group that defines the standards for CIM, and hence do not have parent classes. CIM_Dependency does relationship or association between two managed system

hierarchy from which all other CIM classes are derived. As a result,

cards. For the CIM_ManagedSystemElement properties, see

not have a parent class because it is a

elements.

Parent Classes

Most classes in the dccim32 provider document both a Class Name and a Parent Class property. The

inherits its core properties. For example, the CIM_Controller class has the CIM_LogicalDevice class as its parent, and has various types of

controllers (CIM_ParallelController, CIM_SerialController) as its children.

parent class is the class from which any given class

Classes That Describe Relationships

Classes that derive from CIM_Dependency have CIM_Dependency as their parent class, but they are documented in terms of antecedent and dependent elements in a relationship rather than in terms of common properties. Consider the following relationship between two CIM_ManagedSystemElements:

Antecedent CIM_PackageCurrentSensor

Dependent CIM_PhysicalPackage

12 Introduction

The CIM_PackageCurrentSensor monitors an entire physical package, such as all the components contained in a given system chassis. The

CIM_PhysicalPackage is dependent on the CIM_PackageCurrentSensor for this monitoring function.

Dell-Defined Classes

Server Administrator has extended some CIM classes and has created new classes to assist in managing systems and their components. In the diagrams that appear in the documentation for each class, those classes created and populated by Dell are designated by the gold (lighter gray) triangle

icon.

Common Properties of Classes

Many classes have properties such as Caption, Description, and CreationClassName.

every class that has this property and are defined more than once in this guide.

Table 1-1. Common Properties of Classes

Property Description Data Type

Caption Describes the object using a short textual

CreationClassName Indicates the name of the class or the

CSCreationClassName Indicates the computer system’s creation

CSName Indicates the computer system’s name. string

CurrentReading Indicates the actual current value indicated

Description Provides a textual description of the object. string

LowerThresholdNonCritical If current reading is between lower threshold

Ta b l e 1-1 defines properties that have the same meaning in

string

description (one-line string).

string subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.

string class name.

sint32 by the sensor in amperes.

sint32 noncritical and upper threshold noncritical, the current state is normal. See Figure 3-2.

Introduction 13

Table 1-1. Common Properties of Classes (continued)

Property Description Data Type

LowerThresholdCritical If the current reading is between upper

threshold critical and upper threshold fatal, the current state is critical. See Figure 3-2.

IsLinear Indicates that the sensor is linear over its

dynamic range.

Manufacturer Provides the name of the organization

responsible for producing the CIM_PhysicalElement or CIM_SoftwareElement. This may be the entity from whom the element is purchased, but not necessarily. Purchase information is contained in the Ve nd or property of CIM_Product.

Name Defines the label by which the object is

known. When subclassed, the Name property can be overridden to be a Key property.

Status Provides a string indicating the status of the

component. Status values include:

Operational Status Values:

OK indicates that the object is functioning normally.

Degraded means that the item is functioning, but not optimally.

Stressed indicates that the element is functioning, but needs attention. Examples of Stressed states are overloaded, overheated, and so on.

sint32

Boolean

string

14 Introduction

Nonoperational Status Values:

Non-recover means that a nonrecoverable error has occurred.

Error means that an element has encountered an operational condition that is severe as compared to its normal mode of operation.

Table 1-1. Common Properties of Classes (continued)

Property Description Data Type

SystemCreationClassName Indicates the system’s creation class name. string

UnitModifier Provides the unit multiplier for the values

returned by this sensor. All the values returned by this sensor are represented in units of 10 raised to the power of the unit modifier. If the unit modifier is –6, then the units of the values returned are microvolts. The units apply to all numeric properties of the sensor, unless explicitly overridden by the units’ qualifier.

UpperThresholdCritical If the current reading is between upper

threshold critical and upper threshold fatal, the current status is critical. See Figure 3-2.

UpperThresholdNonCritical If the current reading is between lower

threshold noncritical and lower threshold critical, the current status is noncritical. See Figure 3-2.

Version Version should be in the form

<major>.<minor>.<revision> or <major>.<minor><letter><revision>; for example, 1.2.3 or 1.2a3.

sint32

string

Typographical Conventions

The following example shows how most of the classes in the Dell CIM provider are documented. class. (For a full class description, see Ta b l e 3-42)

Class Name appears in Courier typeface and provides the string that names the class in the MOF.

Paren t Class appears in Courier typeface and provides the name of the class from which the present class is derived.

Property denotes the name of the attribute that is being defined for this class.

Description includes text that defines the property.

Data Type stipulates the format that the values of this property must take.

Common data types include Boolean, string, and various types of integer. Boolean indicates that the property must be expressed as one of two alternatives.

Ta b l e 1-2 shows a partial class description for the DELL_DMA

16 Introduction

Table 1-2. CIM_DMA Properties

Class Name:

CIM_DMA

Parent Class: CIM_SystemResource

Property Description Data Type

DMAChannel A part of the object’s key value, the DMA channel

uint32

number.

Availability Availability of the DMA. Availability values are

uint16

defined as follows:

1 - Other

2 - Unknown

3 - Available

4 - In Use/Not Available

5 - In Use and Available/Shareable

Introduction 17

18 Introduction

CIM_PhysicalElement

CIM_PhysicalElement is a CIM-defined class. The CIM_PhysicalElement class contains the subclasses shown in

Figure 2-1. CIM_PhysicalElement Class Structure

CIM_ManagedSystemElement

CIM_PhysicalElement

CIM_PhysicalPackage

CIM_PhysicalFrame

CIM_Chassis

DELL_Chassis

CIM_PhysicalComponent

CIM_Chip

CIM_PhysicalMemory

CIM_PhysicalConnector

CIM_Slot

CIM_PhysicalElement

CIM_ManagedSystemElement

Figure 2-1.

CIM_PhysicalElement

Subclasses of the CIM_PhysicalElement class listed in Table 2-1 define any component of a system that has a distinct physical identity. Physical elements are tangible managed system elements (usually actual hardware items) that have a physical manifestation of some sort. By contrast, processes, files, and logical devices are not classified as physical elements. A managed system element is not necessarily a discrete component. A single card (which

is a type of physical element) can host more than one logical device.

One card, for example, could implement both a modem and a

local area network (LAN) adapter. In this case, the card would be represented by a single physical element associated with multiple logical devices.

CIM_PhysicalElement 19

Table 2-1. CIM_PhysicalElement Properties

Class Name: CIM_PhysicalElement

Parent Class: CIM_ManagedSystemElement

Property Description Data Type

CreationClassN ame

Manufacturer See Table 1-1.

Model The name by which the physical element is generally

SerialNumber A manufacturer-allocated number used to identify the

Tag Uniquely identifies the physical element and serves as

See Table 1-1.

string

known.

string

physical element.

string the element’s key. The Ta g property can contain information such as asset tag or serial number data. The key for physical element is placed very high in the object hierarchy in order to identify the hardware/entity independently, regardless of physical placement in or on cabinets, adapters, and so on. For example, a hotswappable or removable component can be taken from its containing (scoping) package and temporarily unused. The object still continues to exist and may even be inserted into a different scoping container. Therefore, the key for physical element is an arbitrary string that is defined independently of any placement or location-oriented hierarchy.

20 CIM_PhysicalElement

CIM_PhysicalPackage

CIM_ManagedSystemElement

CIM_PhysicalElement

CIM_PhysicalPackage

The CIM_PhysicalPackage class listed in Table 2-2 represents physical elements that contain or host other components. Examples are a rack enclosure or an adapter card with multiple functions.

Table 2-2. CIM_PhysicalPackage Properties

Class Name: CIM_PhysicalPackage

Parent Class: CIM_PhysicalElement

Property Description Data Type

Removable A CIM_PhysicalPackage is removable if it is

designed to be taken in and out of the physical container in which it is normally found without impairing the function of the overall package.

Replaceable A CIM_PhysicalPackage is replaceable if it is

possible to substitute a physically different element for the original element, as in a field replaceable unit (FRU). For example, some computer systems allow the microprocessor to be upgraded to one of a higher clock rating. In this case, the microprocessor is said to be replaceable.

Boolean

CIM_PhysicalElement 21

CIM_PhysicalFrame

CIM_ManagedSystemElement

CIM_PhysicalElement

CIM_PhysicalPackage

CIM_PhysicalFrame

The CIM_PhysicalFrame class described in Table 2-3 contains other frame enclosures such as racks and chassis. Properties like VisibleAlarm or AudibleAlarm, and data related to security breaches are also members of this

class.

Table 2-3. CIM_Physical Frame Properties

Class Name: CIM_PhysicalFrame

Parent Class: CIM_PhysicalPackage

Property Description Data Type

LockPresent Indicates whether the frame is protected with a

lock.

AudibleAlarm Indicates whether the frame is equipped with an

audible alarm.

VisibleAlarm Indicates that the equipment includes a

visible alarm.

SecurityBreach An enumerated, integer-valued property

indicating that a physical breach of the frame is in progress. Values for the SecurityBreach property are:

1 - Other

2 - Unknown

3 - No breach

4 - Breach attempted

5 - Breach successful

IsLocked Indicates that the frame is currently locked. Boolean

Boolean

uint16

22 CIM_PhysicalElement

CIM_Chassis

CIM_ManagedSystemElement

CIM_PhysicalElement

CIM_PhysicalPackage

CIM_PhysicalFrame

CIM_Chassis

The CIM_Chassis class described in Table 2-4 represents the physical elements that enclose physical elements such as power supplies, fans, and

processors.

Table 2-4. CIM_Chassis Parent Properties

Class Name: CIM_Chassis

Parent Class: CIM_PhysicalFrame

Property Description Data Type

ChassisTypes Values for the ChassisTypes property are:

1 - Other

2 - Unknown

3 - Mini-tower

4 - Tower

5 - Space-saving

6 - Main system chassis

7 - Expansion chassis

8 - Subchassis

9 - Space-saving

10 - Main system chassis

11 - Expansion chassis

12 - Subchassis

13 - Bus expansion chassis

14 - Peripheral chassis

15 - Storage chassis

16 - Rack-mount chassis

uint16

CIM_PhysicalElement 23

DELL_Chassis

CIM_ManagedSystemElement

CIM_PhysicalElement

CIM_PhysicalPackage

CIM_PhysicalFrame

CIM_Chassis

DELL_Chassis

The DELL_Chassis class explained in Table 2-5 defines the identifying and status properties of the chassis. DELL_Chassis inherits from CIM-defined classes, but is populated by Dell™ properties.

Table 2-5. DELL_Chassis Properties

Class Name: DELL_Chassis

Parent Class: CIM_Chassis

Property Description Data Type

AssetTag Indicates the container AssetTag string. This

asset tag string is writable by the system administrator.

SystemClass Refers to the system type that is installed and

running the instrumentation. Values for the SystemClass property are:

1 - Other

2 - Unknown

3 - Workstation

4 - Server

5 - Desktop

6 - Portable

7 - Net PC

SystemID Indicates the system identifier code. uint16

string

uint16

24 CIM_PhysicalElement

Table 2-5. DELL_Chassis Properties (continued)

Class Name: DELL_Chassis

Parent Class: CIM_Chassis

Property Description Data Type

LogFormat Defines whether the event log data is unicode

uint16 formatted or binary (raw). Values for the event LogFormat property are:

1 - Formatted (event log only)

2 - Unformatted

3 - Events_and_POST_Formatted (both the event

log and the power-on self-test (POST) log are unicode for matted)

FanStatus Indicates the global status of fan sensors. string

TempStatus Indicates the global status of temperature

string sensors.

VoltStatus Indicates the global status of voltage sensors. string

AmpStatus Indicates the global status of current sensors. string

PsStatus Indicates the global status of power supplies. string

MemStatus Indicates the global status of memory devices. string

ProcStatus Indicates the global status of processor devices. string

FanRedStatus Indicates the global status of the cooling unit. string

PsRedStatus Indicates the global status of the power unit. string

IsDefaultThrSupported Indicates whether resetting default thresholds

Boolean are supported.

ChassisSystemProperties Indicates chassis characteristics, such as energy

uint16 smart etc.

ChassisSystemRevision Indicates the chassis revision. uint16

EsmLogStatus Indicates the global status of ESM log. string

MemoryRedStatus Indicates the global status of memory

string redundancy.

CIM_PhysicalElement 25

CIM_PhysicalComponent

CIM_ManagedSystemElement

CIM_PhysicalElement

CIM_PhysicalComponent

The CIM_PhysicalComponent class listed in Table 2-6 represents any low-level or basic component within a package. A component object either cannot or does not need to be broken down into its constituent parts. For example, an application specific integrated circuit (ASIC) cannot be broken down into smaller discrete parts.

Table 2-6. CIM_PhysicalComponent Properties

Class Name: CIM_PhysicalComponent

Parent Class: CIM_PhysicalElement

CIM_Chip

CIM_ManagedSystemElement

CIM_PhysicalElement

CIM_PhysicalComponent

CIM_Chip

The CIM_Chip class listed in Table 2-7 represents any type of integrated circuit hardware, including ASICs, processors, memory chips, and so on.

26 CIM_PhysicalElement

Table 2-7. CIM_Chip Properties

Class Name: CIM_Chip

Parent Class: CIM_PhysicalComponent

Property Description Data Type

FormF ac to r

0 - Unknown

1 - Other

2 - SIP

3 - DIP

4 - ZIP

5 - SOJ

6 - Proprietary

7 - SIMM

8 - DIMM

9 - TSOP

10 - PGA

11 - RIMM

12 - SODIMM

13 - SRIMM

14 - SMD

15 - SSMP

16 - QFP

17 - TQFP

18 - SOIC

19 - LCC

20 - PLCC

21 - BGA

22 - FPBGA

23 - LGA

24 - FB-DIMM

uint16

CIM_PhysicalElement 27

CIM_PhysicalMemory

CIM_ManagedSystemElement

CIM_PhysicalElement

CIM_PhysicalComponent

CIM_Chip

CIM_PhysicalMemory

The CIM_PhysicalMemory class described in Table 2-8 is a subclass of CIM_Chip, representing low-level memory devices, such as SIMMS,

DIMMs, and so on.

Table 2-8. CIM_PhysicalMemory Properties

Class Name: CIM_PhysicalMemory

Parent Class: CIM_Chip

Property Description Data Type

FormFactor See Table 2-7. uint16

MemoryType Indicates the type of physical memory. Values for

the MemoryType property are:

0 - Unknown

1 - Other

2 - DRAM

3 - Synchronous DRAM

4 - Cache DRAM

5 - EDO

6 - EDRAM

7 - VRAM

8 - SRAM

9 - RAM

10 - ROM

uint16

28 CIM_PhysicalElement

Table 2-8. CIM_PhysicalMemory Properties (continued)

Class Name: CIM_PhysicalMemory

Parent Class: CIM_Chip

Property Description Data Type

MemoryType

(continued)

TotalWidth Indicates the total width, in bits, of the physical

11 - Flash

12 - EEPROM

13 - FEPROM

14 - EPROM

15 - CDRAM

16 - 3DRAM

17 - SDRAM

18 - SGRAM

19 - RDRAM

20 - DDR

21 - DDR2

22 - DDR2 FB-DIMM

24 - DDR3

uint16 memory, including check or error correction bits. If there are no error correction bits, the value in this property should match that specified for the DataWidth property.

DataWidth Indicates the data width, in bits, of the physical

uint16 memory. A data width of 0 and a total width of 8 would indicate that the memory is solely used to provide error correction bits.

Speed Indicates the speed of the physical memory, in

uint32 nanoseconds.

SpeedAsString Indicates the accurate speed of the physical

string memory, in string format (with units).

Capacity Indicates the total capacity of this physical

uint64 memory, in bytes.

CIM_PhysicalElement 29

Table 2-8. CIM_PhysicalMemory Properties (continued)

Class Name: CIM_PhysicalMemory

Parent Class: CIM_Chip

Property Description Data Type

BankLabel A string identifying the physically labeled bank

where the memory is located, for example, "Bank 0" or "Bank A."

PositionInRow Specifies the position of the physical memory in a

“row.” For example, if it takes two 8-bit memory devices to form a 16-bit row, then a value of 2 means that this memory is the second device. 0 is an invalid value for this property.

InterleavePosition Indicates the position of this physical memory in

an interleave. 0 indicates noninterleaved. 1 indicates the first position, 2 the second position, and so on. For example, in a 2:1 interleave, a value of 1 indicates that the memory is in the “even” position.

string

uint32

CIM_PhysicalConnector

CIM_ManagedSystemElement

CIM_PhysicalElement

CIM_PhysicalConnector

The CIM_PhysicalConnector class explained in Table 2-9 includes physical elements such as plugs, jacks, or buses that connect physical elements. Any object that can be used to connect and transmit signals or power between two or more physical elements is a member of this class. For example, slots and

D-shell connectors are types of physical connectors. See

Ta b l e 2-10 for a list of valid connector type values.

30 CIM_PhysicalElement

+ 114 hidden pages

Dell OpenManage Server Administrator Version 6.1 CIM Reference Guide

Introduction

Server Administrator

Documenting CIM Classes and Their Properties

Base Classes

Parent Classes

Classes That Describe Relationships

Dell-Defined Classes

Common Properties of Classes

Other Documents You May Need

Typographical Conventions

CIM_PhysicalElement

CIM_PhysicalElement

CIM_PhysicalPackage

CIM_PhysicalFrame

CIM_Chassis

DELL_Chassis

CIM_PhysicalComponent

CIM_Chip

CIM_PhysicalMemory

CIM_PhysicalConnector