CIM_Chassis class

T

he CIM_Chassis class represents the physical elements that enclose other elements and provide definable functionality, such as a desktop, processing node, UPS, disk or tape storage, or a combination of these.

Important  The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties. Properties are listed in alphabetic order, not MOF order.

Syntax

class CIM_Chassis : CIM_PhysicalFrame
{
  boolean  AudibleAlarm;
  string   BreachDescription;
  string   CableManagementStrategy;
  string   Caption;
  uint16   ChassisTypes[];
  string   CreationClassName;
  sint16   CurrentRequiredOrProduced;
  real32   Depth;
  string   Description;
  uint16   HeatGeneration;
  real32   Height;
  boolean  HotSwappable;
  datetime InstallDate;
  boolean  LockPresent;
  string   Manufacturer;
  string   Model;
  string   Name;
  uint16   NumberOfPowerCords;
  string   OtherIdentifyingInfo;
  string   PartNumber;
  boolean  PoweredOn;
  boolean  Removable;
  boolean  Replaceable;
  uint16   SecurityBreach;
  string   SerialNumber;
  string   ServiceDescriptions[];
  uint16   ServicePhilosophy[];
  string   SKU;
  string   Status;
  string   Tag;
  string   TypeDescriptions[];
  string   Version;
  boolean  VisibleAlarm;
  real32   Weight;
  real32   Width;
};

Members

The CIM_Chassis class has these types of members:

Methods

The CIM_Chassis class has these methods.

MethodDescription
IsCompatible

Verifies whether the referenced physical element can be contained by, or inserted into, the physical package. Not implemented by WMI.

 

Properties

The CIM_Chassis class has these properties.

AudibleAlarm
Data type: boolean
Access type: Read-only

If TRUE, the frame is equipped with an audible alarm. This property is inherited from CIM_PhysicalFrame.

BreachDescription
Data type: string
Access type: Read-only

Free-form string that provides information if the SecurityBreach property indicates that a breach or some other security-related event occurred. This property is inherited from CIM_PhysicalFrame.

CableManagementStrategy
Data type: string
Access type: Read-only

Free-form string that contains information on how various cables are connected and bundled for the frame. This string property aids in frame assembly and service. This property is inherited from CIM_PhysicalFrame.

Caption
Data type: string
Access type: Read-only

Short textual description of the object. This property is inherited from CIM_ManagedSystemElement.

ChassisTypes
Data type: uint16 array
Access type: Read-only

Enumerated, integer-valued array that indicates the type of chassis.

ValueMeaning
1

Other.

2

Unknown.

3

Desktop.

4

Low-profile desktop.

5

Pizza box.

6

Mini tower.

7

Tower.

8

Portable.

9

Laptop.

10

Notebook.

11

Hand-held.

12

Docking station.

13

All-in-one.

14

Subnotebook.

15

Space-saving.

16

Lunch box.

17

Main system chassis.

18

Expansion chassis.

19

Subchassis.

20

Bus-expansion chassis.

21

Peripheral chassis.

22

Storage chassis.

23

Rack-mount chassis.

24

Sealed-case computer.

 

CreationClassName
Data type: string
Access type: Read-only

Name of the class or subclass used in the creation of an instance. When used with the other key properties of the class, this property allows all instances of the class and its subclasses to be uniquely identified. This property is inherited from CIM_PhysicalElement.

CurrentRequiredOrProduced
Data type: sint16
Access type: Read-only

Currently required by the chassis at 120 volts. If power is provided by the chassis (as in the case of a UPS), this property can indicate the amperage produced, as a negative number.

Depth
Data type: real32
Access type: Read-only

Depth of the physical package in inches. This property is inherited from CIM_PhysicalPackage.

Description
Data type: string
Access type: Read-only

Textual description of the object. This property is inherited from CIM_ManagedSystemElement.

HeatGeneration
Data type: uint16
Access type: Read-only

Amount of heat generated by the chassis in Btu/hour.

Height
Data type: real32
Access type: Read-only

Height of the physical package in inches. This property is inherited from CIM_PhysicalPackage.

HotSwappable
Data type: boolean
Access type: Read-only

If TRUE, it is possible to replace the element with a physically different, but equivalent one, while the containing package is "on." For example, a disk-drive package that is inserted using SCA connectors is removable and can be hot-swapped. All packages that can be hot-swapped are inherently removable and replaceable. This property is inherited from CIM_PhysicalPackage.

InstallDate
Data type: datetime
Access type: Read-only

Date and time when the object was installed. This property does not need a value to indicate that the object is installed. This property is inherited from CIM_ManagedSystemElement.

LockPresent
Data type: boolean
Access type: Read-only

If TRUE, the frame is protected with a lock. This property is inherited from CIM_PhysicalFrame.

Manufacturer
Data type: string
Access type: Read-only

Organization responsible for producing the physical element. For more information, see the Vendor property of the CIM_Product class. This property is inherited from CIM_PhysicalElement.

Model
Data type: string
Access type: Read-only

Name by which the physical element is generally known. This property is inherited from CIM_PhysicalElement.

Name
Data type: string
Access type: Read-only

Label by which the object is known. When subclassed, this property can be overridden to be a key property. This property is inherited from CIM_ManagedSystemElement.

NumberOfPowerCords
Data type: uint16
Access type: Read-only

Number of power cords that must be connected to the chassis so that all of the components can operate.

OtherIdentifyingInfo
Data type: string
Access type: Read-only

Additional data, beyond asset tag information, that can be used to identify a physical element. One example is bar-code data that is associated with an element, which also has an asset tag. Note that if only bar-code data is available, and is unique and able to be used as an element key, this property would be NULL and the bar-code data would be used as the class key in the Tag property. This property is inherited from CIM_PhysicalElement.

PartNumber
Data type: string
Access type: Read-only

Part number assigned by the organization responsible for producing or manufacturing the physical element. This property is inherited from CIM_PhysicalElement.

PoweredOn
Data type: boolean
Access type: Read-only

If TRUE, the physical element is powered on. If FALSE, the element is powered off. This property is inherited from CIM_PhysicalElement.

Removable
Data type: boolean
Access type: Read-only

If TRUE, this element 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 packaging. A package is considered removable even if the power must be "off" to perform the removal. If the power can be "on" and the package removed, then the element is removable and can be hot-swapped. For example, an extra battery in a laptop is removable, as is a disk-drive package inserted using SCA connectors; however, the latter can be hot-swapped. A laptop's display is not removable, nor is a nonredundant power supply. Removing these components impacts the function of the overall packaging or is impossible due to the tight integration of the package. This property is inherited from CIM_PhysicalPackage.

Replaceable
Data type: boolean
Access type: Read-only

If TRUE, it is possible to replace (field replaceable unit (FRU) or upgrade) the element with a physically different one. For example, some computer systems allow the main processor chip to be upgraded to one of a higher clock rating. In this case, the processor is said to be replaceable. Another example is a power-supply package mounted on sliding rails. All removable packages are inherently replaceable. This property is inherited from CIM_PhysicalPackage.

SecurityBreach
Data type: uint16
Access type: Read-only

Enumerated, integer-value property that indicates whether a physical breach of the frame was attempted but unsuccessful, or attempted and successful. Also, the values, "Unknown", "Other", or "No Breach" can be specified. This property is inherited from CIM_PhysicalFrame.

ValueMeaning
1

Other.

2

Unknown.

3

No breach.

4

Breach attempted.

5

Breach successful.

 

SerialNumber
Data type: string
Access type: Read-only

Manufacturer-allocated number used to identify the physical element. This property is inherited from CIM_PhysicalElement.

ServiceDescriptions
Data type: string array
Access type: Read-only

Array of free-form strings that provides detailed descriptions for entries in the ServicePhilosophy array.

Note  Each array entry is related to the entry in the ServicePhilosophy property, which is located at the same index.

This property is inherited from CIM_PhysicalFrame.

ServicePhilosophy
Data type: uint16 array
Access type: Read-only

Enumerated, integer-valued array that indicates whether the frame is serviced from the top, front, back, or side, and whether it has sliding trays, removable sides, and whether the frame is moveable (for example, having rollers). This property is inherited from CIM_PhysicalFrame.

ValueMeaning
0

Unknown.

1

Other.

2

Service from top.

3

Service from front.

4

Service from back.

5

Service from side.

6

Sliding trays.

7

Removable sides.

8

Moveable.

 

SKU
Data type: string
Access type: Read-only

Stock-keeping unit number for the physical element. This property is inherited from CIM_PhysicalElement.

Status
Data type: string
Access type: Read-only

Status of the object. This property is inherited from CIM_ManagedSystemElement.

Values include the following:

"OK"
"Error"
"Degraded"
"Unknown"
"Pred Fail"
"Starting"
"Stopping"
"Service"
"Stressed"
"NonRecover"
"No Contact"
"Lost Comm"
Tag
Data type: string
Access type: Read-only

Uniquely identifies the physical element and serves as the element's key. This property can contain information such as asset tag or serial number data. The key for the CIM_PhysicalElement class is placed very high in the object hierarchy to independently identify the hardware or entity, regardless of physical placement in (or on) cabinets, adapters, and so on. For example, a removable component that can be hot-swapped can be taken from its containing (scoping) package and be temporarily unused. The object still continues to exist and can even be inserted into a different scoping container. The key for a physical element is an arbitrary string that is defined independently of placement or location-oriented hierarchy. This property is inherited from CIM_PhysicalElement.

TypeDescriptions
Data type: string array
Access type: Read-only

Array of free-form strings that provides information about the ChassisTypes array entries.

Note  Each array entry is related to the entry in the ChassisTypes property, which is located at the same index.

Version
Data type: string
Access type: Read-only

Version of the physical element. This property is inherited from CIM_PhysicalElement.

VisibleAlarm
Data type: boolean
Access type: Read-only

If TRUE, the equipment includes a visible alarm. This property is inherited from CIM_PhysicalFrame.

Weight
Data type: real32
Access type: Read-only

Weight of the physical package in pounds. This property is inherited from CIM_PhysicalPackage.

Width
Data type: real32
Access type: Read-only

Width of the physical package in inches. This property is inherited from CIM_PhysicalPackage.

Remarks

The CIM_Chassis class is derived from CIM_PhysicalFrame.

WMI does not implement this class. For more information about classes derived from CIM_Chassis, see Win32 Classes.

This documentation is derived from the CIM class descriptions published by the DMTF. Microsoft may have made changes to correct minor errors, conform to Microsoft SDK documentation standards, or provide more information.

Examples

For script code examples, see WMI Tasks for Scripts and Applications and the TechNet ScriptCenter Script Repository.

For C++ code examples, see WMI C++ Application Examples.

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

Namespace

\root\CIMV2

MOF

CIMWin32.mof

DLL

CIMWin32.dll

 

 

Show:
© 2014 Microsoft. All rights reserved.