CIM_Chassis class

Article
01/06/2021

The 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

[abstract, UUID("{FAF76B72-798C-11D2-AAD1-006008C78BC7}"), AMENDMENT]
class CIM_Chassis : CIM_PhysicalFrame
{
  string   Caption;
  string   Description;
  datetime InstallDate;
  string   Name;
  string   Status;
  string   CreationClassName;
  string   Manufacturer;
  string   Model;
  string   OtherIdentifyingInfo;
  string   PartNumber;
  boolean  PoweredOn;
  string   SerialNumber;
  string   SKU;
  string   Tag;
  string   Version;
  real32   Depth;
  real32   Height;
  boolean  HotSwappable;
  boolean  Removable;
  boolean  Replaceable;
  real32   Weight;
  real32   Width;
  boolean  AudibleAlarm;
  string   BreachDescription;
  string   CableManagementStrategy;
  boolean  LockPresent;
  uint16   SecurityBreach;
  string   ServiceDescriptions[];
  uint16   ServicePhilosophy[];
  boolean  VisibleAlarm;
  uint16   ChassisTypes[];
  sint16   CurrentRequiredOrProduced;
  uint16   HeatGeneration;
  uint16   NumberOfPowerCords;
  string   TypeDescriptions[];
};

Members

The CIM_Chassis class has these types of members:

Methods
Properties

Methods

The CIM_Chassis class has these methods.

Method	Description
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
Qualifiers: ModelCorrespondence ("CIM_PhysicalFrame.SecurityBreach")

Free-form string that provides more 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 the various cables are connected and bundled for the frame. With many networking, storage-related, and power cables, cable management can be a complex and challenging endeavor. This string property contains information to aid in assembly and service of the frame.

This property is inherited from CIM_PhysicalFrame.

Caption

Data type: string
Access type: Read-only
Qualifiers: MaxLen (64), DisplayName ("Caption")

A short textual description of the object.

This property is inherited from CIM_ManagedSystemElement.

ChassisTypes

Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), MappingStrings ("MIF.DMTF|Physical Container Global Table|002.1"), ModelCorrespondence ("CIM_Chassis.TypeDescriptions")

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

Other (1)

Other.

Unknown (2)

Unknown.

Desktop (3)

Desktop.

Low Profile Desktop (4)

Low-profile desktop.

Pizza Box (5)

Pizza box.

Mini Tower (6)

Mini tower.

Tower (7)

Tower.

Portable (8)

Portable.

Laptop (9)

Laptop.

Notebook (10)

Notebook.

Hand Held (11)

Hand-held.

Docking Station (12)

Docking station.

All in One (13)

All-in-one.

Sub Notebook (14)

Subnotebook.

Space-Saving (15)

Space-saving.

Lunch Box (16)

Lunch box.

Main System Chassis (17)

Main system chassis.

Expansion Chassis (18)

Expansion chassis.

SubChassis (19)

Subchassis.

Bus Expansion Chassis (20)

Bus-expansion chassis.

Peripheral Chassis (21)

Peripheral chassis.

Storage Chassis (22)

Storage chassis.

Rack Mount Chassis (23)

Rack-mount chassis.

Sealed-Case PC (24)

Sealed-case computer.

CreationClassName

Data type: string
Access type: Read-only
Qualifiers: CIM_Key, MaxLen (256)

Name of the class or subclass used in the creation of an instance. When used with 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
Qualifiers: Units ("amps at 120 volts")

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
Qualifiers: Units ("inches")

Depth of the physical package, in inches.

This property is inherited from CIM_PhysicalPackage.

Description

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Description")

A textual description of the object.

This property is inherited from CIM_ManagedSystemElement.

HeatGeneration

Data type: uint16
Access type: Read-only
Qualifiers: Units ("BTU per hour")

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

Height

Data type: real32
Access type: Read-only
Qualifiers: Units ("inches")

Height of the physical package, in inches.

This property is inherited from CIM_PhysicalPackage.

HotSwappable

Data type: boolean
Access type: Read-only

If TRUE, the package can be hot-swapped. A physical package can be hot-swapped if the element can be replaced by a physically different (but equivalent) one while the containing package is turned on. For example, a fan component may be designed to be hot-swapped. All components 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
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5"), DisplayName ("Install Date")

Indicates when the object was installed. Lack of a value does not indicate that the object is not 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
Qualifiers: MaxLen (256)

Name of the organization responsible for producing the physical element. For more information, see the Vendor property of CIM_Product.

This property is inherited from CIM_PhysicalElement.

Model

Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

Name by which the physical element is generally known.

This property is inherited from CIM_PhysicalElement.

Name

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Name")

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
Qualifiers: MaxLen (256)

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. Otherwise, it is currently off.

This property is inherited from CIM_PhysicalElement.

Removable

Data type: boolean
Access type: Read-only

If TRUE, the package 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 upgradeable processor chip is removable.

This property is inherited from CIM_PhysicalPackage.

Replaceable

Data type: boolean
Access type: Read-only

If TRUE, it is possible to replace 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. All removable components are inherently replaceable.

This property is inherited from CIM_PhysicalPackage.

SecurityBreach

Data type: uint16
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|Physical Container Global Table|002.12"), ModelCorrespondence ("CIM_PhysicalFrame.BreachDescription")

Indicates whether a physical breach of the frame was attempted but unsuccessful, or attempted and successful.

This property is inherited from CIM_PhysicalFrame.

Other (1)

Unknown (2)

No Breach (3)

Breach Attempted (4)

Breach Successful (5)

SerialNumber

Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

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
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_PhysicalFrame.ServicePhilosophy")

Free-form strings that provide detailed explanations for entries in the ServicePhilosophy array.

Note

Each entry of this array is related to the entry in ServicePhilosophy array that is located at the same index.

This property is inherited from CIM_PhysicalFrame.

ServicePhilosophy

Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_PhysicalFrame.ServiceDescriptions")

Indicates whether the frame is serviced from the top, front, back, or side; and whether it has sliding trays or removable sides, and whether the frame is moveable (for example, having rollers).

This property is inherited from CIM_PhysicalFrame.

Unknown (0)

Other (1)

Service From Top (2)

Service From Front (3)

Service From Back (4)

Service From Side (5)

Sliding Trays (6)

Removable Sides (7)

Moveable (8)

SKU

Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

Stock-keeping unit number for this physical element.

This property is inherited from CIM_PhysicalElement.

Status

Data type: string
Access type: Read-only
Qualifiers: MaxLen (10), DisplayName ("Status")

String that indicates the current status of the object. Operational and non-operational status can be defined. Operational status can include "OK", "Degraded", and "Pred Fail". "Pred Fail" indicates that an element is functioning properly, but is predicting a failure (for example, a SMART-enabled hard disk drive).

Non-operational status can include "Error", "Starting", "Stopping", and "Service". "Service" can apply during disk mirror-resilvering, reloading a user permissions list, or other administrative work. Not all such work is online, but the managed element is neither "OK" nor in one of the other states.

This property is inherited from CIM_ManagedSystemElement.

Values include the following:

OK ("OK")

Error ("Error")

Degraded ("Degraded")

Unknown ("Unknown")

Pred Fail ("Pred Fail")

Starting ("Starting")

Stopping ("Stopping")

Service ("Service")

Stressed ("Stressed")

NonRecover ("NonRecover")

No Contact ("No Contact")

Lost Comm ("Lost Comm")

Tag

Data type: string
Access type: Read-only
Qualifiers: CIM_Key, MaxLen (256)

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 CIM_PhysicalElement 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
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_Chassis.ChassisTypes")

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
Qualifiers: MaxLen (64)

Indicates the 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
Qualifiers: Units ("pounds")

Weight of the physical package, in pounds.

This property is inherited from CIM_PhysicalPackage.

Width

Data type: real32
Access type: Read-only
Qualifiers: Units ("inches")

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.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Namespace	Root\CIMV2
MOF	CIMWin32.mof
DLL	CIMWin32.dll

CIM_Chassis class

Syntax

Members

Methods

Properties

Remarks

Requirements

See also

Feedback

Feedback

Additional resources