CIM_PhysicalFrame class

The CIM_PhysicalFrame class is a parent class of rack, chassis, and other frame enclosures as they are defined in extension classes. Properties such as VisibleAlarm and AudibleAlarm, and data related to security breaches are included in this parent class.

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 of its inherited properties. Properties are listed in alphabetic order, not MOF order.

Syntax

class CIM_PhysicalFrame : CIM_PhysicalPackage
{
  boolean  AudibleAlarm;
  string   BreachDescription;
  string   CableManagementStrategy;
  string   Caption;
  string   CreationClassName;
  real32   Depth;
  string   Description;
  real32   Height;
  boolean  HotSwappable;
  datetime InstallDate;
  boolean  LockPresent;
  string   Manufacturer;
  string   Model;
  string   Name;
  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   Version;
  boolean  VisibleAlarm;
  real32   Weight;
  real32   Width;
};

Members

The CIM_PhysicalFrame class has these types of members:

Methods

The CIM_PhysicalFrame 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_PhysicalFrame class has these properties.

AudibleAlarm
Data type: boolean
Access type: Read-only

If TRUE, the frame is equipped with an audible alarm.

BreachDescription
Data type: string
Access type: Read-only

Free-form string that provides more information if the SecurityBreach property indicates that a breach or some other security-related event occurred.

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.

Caption
Data type: string
Access type: Read-only

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

CreationClassName
Data type: string
Access type: Read-only

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.

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.

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, 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

Date and time 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.

Manufacturer
Data type: string
Access type: Read-only

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

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.

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; otherwise, it is currently 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 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

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

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

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.

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

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).

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

Current 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

Arbitrary string that 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/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.

Version
Data type: string
Access type: Read-only

String that 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.

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_PhysicalFrame class is derived from CIM_PhysicalPackage.

WMI does not implement this class. For WMI classes derived from CIM_PhysicalFrame, 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.