Edit

CIM_PhysicalPackage class

  • Article

The CIM_PhysicalPackage class represents physical elements that contain or host other components. Examples are a rack enclosure or an adapter card.

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("{FAF76B6E-798C-11D2-AAD1-006008C78BC7}"), AMENDMENT]
class CIM_PhysicalPackage : CIM_PhysicalElement
{
  string   Caption;
  string   CreationClassName;
  real32   Depth;
  string   Description;
  real32   Height;
  boolean  HotSwappable;
  datetime InstallDate;
  string   Manufacturer;
  string   Model;
  string   Name;
  string   OtherIdentifyingInfo;
  string   PartNumber;
  boolean  PoweredOn;
  boolean  Removable;
  boolean  Replaceable;
  string   SerialNumber;
  string   SKU;
  string   Status;
  string   Tag;
  string   Version;
  real32   Weight;
  real32   Width;
};

Members

The CIM_PhysicalPackage class has these types of members:

Methods

The CIM_PhysicalPackage 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_PhysicalPackage class has these properties.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64), DisplayName ("Caption")

Short textual description of the object.

This property is inherited from CIM_ManagedSystemElement.

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.

Depth

Data type: real32

Access type: Read-only

Qualifiers: Units ("inches")

Depth of the physical package, in inches.

Description

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Description")

Textual description of the object.

This property is inherited from CIM_ManagedSystemElement.

Height

Data type: real32

Access type: Read-only

Qualifiers: Units ("inches")

Height of the physical package, in inches.

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.

InstallDate

Data type: datetime

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5"), DisplayName ("Install Date")

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.

Manufacturer

Data type: string

Access type: Read-only

Qualifiers: MaxLen (256)

Name of the organization that produced 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.

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 that produced or manufactured 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.

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.

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.

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.

SKU

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

Stock-keeping unit number for the physical element.

This property is inherited from CIM_PhysicalElement.

Status

Data type: string

Access type: Read-only

Qualifiers: MaxLen (10), DisplayName ("Status")

Current status of the object.

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)

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

Version

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

Version of the physical element.

This property is inherited from CIM_PhysicalElement.

Weight

Data type: real32

Access type: Read-only

Qualifiers: Units ("pounds")

Weight of the physical package, in pounds.

Width

Data type: real32

Access type: Read-only

Qualifiers: Units ("inches")

Width of the physical package, in inches.

Remarks

The CIM_PhysicalPackage class is derived from CIM_PhysicalElement.

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

See also

CIM_PhysicalElement