Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary
CIM_PhysicalFrame --> CIM_PhysicalPackage --> CIM_PhysicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]
Class Declaration Attributes Name Value SUPERCLASS CIM_PhysicalPackage NAME CIM_PhysicalFrame
Class CIM_PhysicalFrame Qualifiers Name Type Value From Class Version string 2.7.0 CIM_PhysicalFrame Description string PhysicalFrame is a superclass of Rack, Chassis and other frame enclosures, as they are defined in extension classes. Properties like visible or audible alarm, and data related to security breaches are in this superclass. CIM_PhysicalFrame Description string The PhysicalPackage class represents PhysicalElements that contain or host other components. Examples are a Rack enclosure or an adapter Card. CIM_PhysicalPackage Description string Subclasses of CIM_PhysicalElement define any component of a System that has a distinct physical identity. Instances of this class can be defined in terms of labels that can be physically attached to the object. All Processes, Files, and LogicalDevices are considered not to be Physical Elements. For example, it is not possible to attach a label to a modem. It is only possible to attach a label to the card that implements the modem. The same card could also implement a LAN adapter. These are tangible Managed SystemElements (usually actual hardware items) that have a physical manifestation of some sort. A ManagedSystem Element is not necessarily a discrete component. For example, it is possible for a single Card (which is a type of PhysicalElement) to host more than one LogicalDevice. The card would be represented by a single PhysicalElement associated with multiple Devices. CIM_PhysicalElement Description string CIM_ManagedSystemElement is the base class for the System Element hierarchy. Any distinguishable component of a System is a candidate for inclusion in this class. Examples of system components include: - software components such as application servers, databases, and applications - operating system components such as files, processes, and threads - device components such as disk drives, controllers, processors, and printers - physical components such as chips and cards. CIM_ManagedSystemElement Description string ManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema. CIM_ManagedElement
Property Qualifiers
Property CableManagementStrategy Qualifiers Name Type Value From Class Description string CableManagementStrategy is a 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. CIM_PhysicalFrame
Property ServicePhilosophy Qualifiers Name Type Value From Class Description string ServicePhilosophy is an enumerated, integer-valued array that indicates whether the Frame is serviced from the top (value=2), front (3), back (4) or side (5), whether it has sliding trays (6) or removable sides (7), and/or whether the Frame is moveable (8), for example, having rollers. CIM_PhysicalFrame ValueMap string [See below.] CIM_PhysicalFrame Values string Unknown
Other
Service From Top
Service From Front
Service From Back
Service From Side
Sliding Trays
Removable Sides
MoveableCIM_PhysicalFrame ArrayType string Indexed CIM_PhysicalFrame ModelCorrespondence string CIM_PhysicalFrame.ServiceDescriptions CIM_PhysicalFrame
Name Value 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
Property ServiceDescriptions Qualifiers Name Type Value From Class Description string An array of free-form strings providing more detailed explanations for any of the entries in the Service Philosophy array. Note, each entry of this array is related to the entry in ServicePhilosophy that is located at the same index. CIM_PhysicalFrame ArrayType string Indexed CIM_PhysicalFrame ModelCorrespondence string CIM_PhysicalFrame.ServicePhilosophy CIM_PhysicalFrame
Property LockPresent Qualifiers Name Type Value From Class Description string Boolean indicating whether the Frame is protected with a lock. CIM_PhysicalFrame
Property AudibleAlarm Qualifiers Name Type Value From Class Description string Boolean indicating whether the Frame is equipped with an audible alarm. CIM_PhysicalFrame
Property VisibleAlarm Qualifiers Name Type Value From Class Description string Boolean indicating that the equipment includes a visible alarm. CIM_PhysicalFrame
Property SecurityBreach Qualifiers Name Type Value From Class Description string SecurityBreach is an enumerated, integer-valued property indicating whether a physical breach of the Frame was attempted but unsuccessful (value=4) or attempted and successful (5). Also, the values, " Unknown " , " Other " or " No Breach " , can be specified. CIM_PhysicalFrame ValueMap string [See below.] CIM_PhysicalFrame Values string Other
Unknown
No Breach
Breach Attempted
Breach SuccessfulCIM_PhysicalFrame MappingStrings string MIF.DMTF|Physical Container Global Table|004.12 CIM_PhysicalFrame ModelCorrespondence string CIM_PhysicalFrame.BreachDescription CIM_PhysicalFrame
Name Value 1 Other 2 Unknown 3 No Breach 4 Breach Attempted 5 Breach Successful
Property BreachDescription Qualifiers Name Type Value From Class Description string BreachDescription is a free-form string providing more information if the SecurityBreach property indicates that a breach or some other security-related event occurred. CIM_PhysicalFrame ModelCorrespondence string CIM_PhysicalFrame.SecurityBreach CIM_PhysicalFrame
Property IsLocked Qualifiers Name Type Value From Class Description string Boolean indicating that the Frame is currently locked. CIM_PhysicalFrame
Property RemovalConditions Qualifiers Name Type Value From Class Description string The RemovalCapabilites property is used to describe the conditions under which a PhysicalPackage can be removed. Since all PhysicalPackages are not removable, this property defaults to 2, ’ Not Applicable ’ . CIM_PhysicalPackage ValueMap string [See below.] CIM_PhysicalPackage Values string Unknown
Not Applicable
Removable when off
Removable when on or offCIM_PhysicalPackage
Name Value 0 Unknown 2 Not Applicable 3 Removable when off 4 Removable when on or off
Property Removable Qualifiers Name Type Value From Class Description string The use of this property is being deprecated. Instead RemovalConditions should be used. The RemovalConditions property addresses whether a PhysicalPackage is removable with or without power being applied. A 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 packaging. A Package can still be Removable if power must be ’ off ’ in order to perform the removal. If power can be ’ on ’ and the Package removed, then the Element is both Removable and HotSwappable. For example, an extra battery in a laptop is Removable, as is a disk drive Package inserted using SCA connectors. However, the latter is also HotSwappable. A laptop ’ s display is not Removable, nor is a non-redundant power supply. Removing these components would impact the function of the overall packaging or is impossible due to the tight integration of the Package. CIM_PhysicalPackage
Property Replaceable Qualifiers Name Type Value From Class Description string The use of this property is being deprecated because it is redundant with the FRU class and its associations. A PhysicalPackage is Replaceable if it is possible to replace (FRU or upgrade) the Element with a physically different one. For example, some ComputerSystems 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. CIM_PhysicalPackage
Property HotSwappable Qualifiers Name Type Value From Class Description string The use of this property is being deprecated. Instead RemovalConditions should be used. The RemovalConditions property addresses whether a PhysicalPackage is removable with or without power being applied. A PhysicalPackage is HotSwappable if it is possible to replace the Element with a physically different but equivalent one while the containing Package has power applied to it (ie, is ’ on ’ ). For example, a disk drive Package inserted using SCA connectors is both Removable and HotSwappable. All HotSwappable packages are inherently Removable and Replaceable. CIM_PhysicalPackage
Property Height Qualifiers Name Type Value From Class Description string The height of the PhysicalPackage in inches. CIM_PhysicalPackage Units string Inches CIM_PhysicalPackage
Property Depth Qualifiers Name Type Value From Class Description string The depth of the PhysicalPackage in inches. CIM_PhysicalPackage Units string Inches CIM_PhysicalPackage
Property Width Qualifiers Name Type Value From Class Description string The width of the PhysicalPackage in inches. CIM_PhysicalPackage Units string Inches CIM_PhysicalPackage
Property Weight Qualifiers Name Type Value From Class Description string The weight of the PhysicalPackage in pounds. CIM_PhysicalPackage Units string Pounds CIM_PhysicalPackage
Property Tag Qualifiers Name Type Value From Class Key boolean true CIM_PhysicalElement Description string An arbitrary string that uniquely identifies the Physical Element and serves as the Element ’ s key. The Tag property can contain information such as asset tag or serial number data. The key for PhysicalElement is placed very high in the object hierarchy in order to independently identify the hardware/entity, regardless of physical placement in or on Cabinets, Adapters, etc. For example, a hotswappable or removeable component may be taken from its containing (scoping) Package and be 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 and is defined independently of any placement or location-oriented hierarchy. CIM_PhysicalElement MaxLen uint32 256 CIM_PhysicalElement
Property CreationClassName Qualifiers Name Type Value From Class Key boolean true CIM_PhysicalElement Description string CreationClassName indicates the name of the class or the 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. CIM_PhysicalElement MaxLen uint32 256 CIM_PhysicalElement
Property ElementName Qualifiers Name Type Value From Class Override string ElementName CIM_PhysicalElement MappingStrings string MIB.IETF|Entity-MIB.entPhysicalName CIM_PhysicalElement Description string A user-friendly name for the object. This property allows each instance to define a user-friendly name IN ADDITION TO its key properties/identity data, and description information. Note that ManagedSystemElement ’ s Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties. CIM_PhysicalElement
Property Manufacturer Qualifiers Name Type Value From Class Description string The name of the organization responsible for producing the PhysicalElement. This may be the entity from whom the Element is purchased, but this is not necessarily true. The latter information is contained in the Vendor property of CIM_Product. CIM_PhysicalElement MaxLen uint32 256 CIM_PhysicalElement MappingStrings string MIB.IETF|Entity-MIB.entPhysicalMfgName CIM_PhysicalElement
Property Model Qualifiers Name Type Value From Class Description string The name by which the PhysicalElement is generally known. CIM_PhysicalElement MaxLen uint32 256 CIM_PhysicalElement MappingStrings string MIB.IETF|Entity-MIB.entPhysicalDescr CIM_PhysicalElement
Property SKU Qualifiers Name Type Value From Class Description string The stock keeping unit number for this PhysicalElement. CIM_PhysicalElement MaxLen uint32 64 CIM_PhysicalElement
Property SerialNumber Qualifiers Name Type Value From Class Description string A manufacturer-allocated number used to identify the Physical Element. CIM_PhysicalElement MaxLen uint32 256 CIM_PhysicalElement MappingStrings string MIB.IETF|Entity-MIB.entPhysicalSerialNum CIM_PhysicalElement
Property Version Qualifiers Name Type Value From Class Description string A string indicating the version of the PhysicalElement. CIM_PhysicalElement MaxLen uint32 64 CIM_PhysicalElement MappingStrings string MIB.IETF|Entity-MIB.entPhysicalHardwareRev CIM_PhysicalElement
Property PartNumber Qualifiers Name Type Value From Class Description string The part number assigned by the organization responsible for producing or manufacturing the PhysicalElement. CIM_PhysicalElement MaxLen uint32 256 CIM_PhysicalElement MappingStrings string MIB.IETF|Entity-MIB.entPhysicalModelName CIM_PhysicalElement
Property OtherIdentifyingInfo Qualifiers Name Type Value From Class Write boolean true CIM_PhysicalElement Description string OtherIdentifyingInfo captures additional data, beyond that of Tag information, that could be used to identify a Physical Element. One example is bar code data associated with an Element that also has an asset tag. Note that if only bar code data is available and is unique/able to be used as an Element key, this property would be NULL and the bar code data used as the class key, in the Tag property. CIM_PhysicalElement MappingStrings string MIB.IETF|Entity-MIB.entPhysicalAlias CIM_PhysicalElement
Property PoweredOn Qualifiers Name Type Value From Class Description string Boolean indicating that the PhysicalElement is powered on (TRUE), or is currently off (FALSE). CIM_PhysicalElement
Property ManufactureDate Qualifiers Name Type Value From Class Description string Date that this PhysicalElement was manufactured. CIM_PhysicalElement
Property VendorEquipmentType Qualifiers Name Type Value From Class Description string A vendor-specific hardware type for the PhysicalElement. It describes the specific equipment type for the element, as defined by the vendor/manufacturer. CIM_PhysicalElement MappingStrings string MIB.IETF|Entity-MIB.entPhysicalVendorType CIM_PhysicalElement
Property UserTracking Qualifiers Name Type Value From Class Write boolean true CIM_PhysicalElement Description string User-assigned and writeable asset tracking identifier for the PhysicalElement. CIM_PhysicalElement MappingStrings string MIB.IETF|Entity-MIB.entPhysicalAssetID CIM_PhysicalElement
Property CanBeFRUed Qualifiers Name Type Value From Class Description string Boolean indicating whether this PhysicalElement can be FRUed (TRUE) or not (FALSE). CIM_PhysicalElement MappingStrings string MIB.IETF|Entity-MIB.entPhysicalIsFRU CIM_PhysicalElement
Property InstallDate Qualifiers Name Type Value From Class Description string A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. CIM_ManagedSystemElement MappingStrings string MIF.DMTF|ComponentID|001.5 CIM_ManagedSystemElement
Property Name Qualifiers Name Type Value From Class Description string The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property. CIM_ManagedSystemElement MaxLen uint32 1024 CIM_ManagedSystemElement
Property OperationalStatus Qualifiers Name Type Value From Class Description string Indicates the current status(es) of the element. Various health and operational statuses are defined. Many of the enumeration ’ s values are self- explanatory. However, a few are not and are described in more detail. " Stressed " indicates that the element is functioning, but needs attention. Examples of " Stressed " states are overload, overheated, etc. " Predictive Failure " indicates that an element is functioning nominally but predicting a failure in the near future. " In Service " describes an element being configured, maintained, cleaned, or otherwise administered. " No Contact " indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it. " Lost Communication " indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable. " Stopped " and " Aborted " are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the element ’ s state and configuration may need to be updated. " Dormant " indicates that the element is inactive or quiesced. " Supporting Entity in Error " describes that this element may be " OK " but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower layer networking problems. " Completed " indicates the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can till if the complete operation passed (Completed with OK), and failure (Completed with Error). Completed with Degraded would imply the operation finished, but did not complete OK or report an error. " Power Mode " indicates the element has additional power model information contained in the Associated PowerManagementService association. OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today ’ s environment to the future. This change was not made earlier since it required the DEPRECATED qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly RECOMMENDED that providers/instrumentation provide BOTH the Status and OperationalStatus properties. Further, the first value of OperationalStatus SHOULD contain the primary status for the element. When instrumented, Status (since it is single-valued) SHOULD also provide the primary status of the element. CIM_ManagedSystemElement ValueMap string [See below.] CIM_ManagedSystemElement Values string Unknown
Other
OK
Degraded
Stressed
Predictive Failure
Error
Non-Recoverable Error
Starting
Stopping
Stopped
In Service
No Contact
Lost Communication
Aborted
Dormant
Supporting Entity in Error
Completed
Power Mode
DMTF Reserved
Vendor ReservedCIM_ManagedSystemElement ArrayType string Indexed CIM_ManagedSystemElement ModelCorrespondence string CIM_ManagedSystemElement.StatusDescriptions CIM_ManagedSystemElement
Name Value 0 Unknown 1 Other 2 OK 3 Degraded 4 Stressed 5 Predictive Failure 6 Error 7 Non-Recoverable Error 8 Starting 9 Stopping 10 Stopped 11 In Service 12 No Contact 13 Lost Communication 14 Aborted 15 Dormant 16 Supporting Entity in Error 17 Completed 18 Power Mode .. DMTF Reserved 0x8000.. Vendor Reserved
Property StatusDescriptions Qualifiers Name Type Value From Class Description string Strings describing the various OperationalStatus array values. For example, if " Stopping " is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Note that entries in this array are correlated with those at the same array index in OperationalStatus. CIM_ManagedSystemElement ArrayType string Indexed CIM_ManagedSystemElement ModelCorrespondence string CIM_ManagedSystemElement.OperationalStatus CIM_ManagedSystemElement
Property Status Qualifiers Name Type Value From Class Description string A string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons: 1) Status is more correctly defined as an array. This overcomes the limitation of describing status via a single value, when it is really a multi-valued property (for example, an element may be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. And, 3) The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the Deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus. CIM_ManagedSystemElement ValueMap string [See below.] CIM_ManagedSystemElement MaxLen uint32 10 CIM_ManagedSystemElement
Name Value OK [none] Error [none] Degraded [none] Unknown [none] Pred Fail [none] Starting [none] Stopping [none] Service [none] Stressed [none] NonRecover [none] No Contact [none] Lost Comm [none] Stopped [none]
Property Caption Qualifiers Name Type Value From Class Description string The Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement MaxLen uint32 64 CIM_ManagedElement
Property Description Qualifiers Name Type Value From Class Description string The Description property provides a textual description of the object. CIM_ManagedElement
Property ElementName Qualifiers Name Type Value From Class Description string A user-friendly name for the object. This property allows each instance to define a user-friendly name IN ADDITION TO its key properties/identity data, and description information. Note that ManagedSystemElement ’ s Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties. CIM_ManagedElement
Name Type Value Qualifiers Parameters ClassOrigin IsCompatible uint32 Deprecated
DescriptionCIM_PhysicalPackage Method Qualifiers
Method IsCompatible Qualifiers Name Type Value From Class Description string This method is being deprecated. A PhysicalPackage cannot determine if it is compatible with another object. The IsCompatible method verifies whether the referenced PhysicalElement may be contained by or inserted into the PhysicalPackage. The return value should be 0 if the request was successfully executed, 1 if the request is not supported and some other value if an error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are ’ translated ’ may also be specified in the subclass as a Values array qualifier. CIM_PhysicalPackage Parameters
Parameter Qualifiers