Physical\CIM_Card.mof.mof (HTML version)

Return to index
CIM_Card Superclass: CIM_PhysicalPackage
The Card class represents a type of physical container that can be plugged into another Card or HostingBoard, or is itself a HostingBoard/Motherboard in a Chassis. The CIM_Card class includes any package capable of carrying signals and providing a mounting point for PhysicalComponents, such as Chips, or other PhysicalPackages, such as other Cards.
Qualifiers:Version ( "2.8.0" )
Parameters (local in grey)
boolean RequiresDaughterBoard ;
Boolean indicating that at least one daughterboard or auxiliary Card is required in order to function properly.
uint32ConnectorPower(
The connector to change the power setting for.
Qualifiers:IN
CIM_PhysicalConnector REF Connector
If TRUE, turn power on for the connector. If FALSE, turn power off.
Qualifiers:IN
boolean PoweredOn
)
This method manipulates the power to a PhysicalConnector on a Card. It is intended to be used by a Card (especially by a motherboard - i.e., HostingBoard=TRUE) to turn the power on and off for a specific PhysicalConnector located on it. For example, in a personal computer, a system slot does not know how to turn itself on and off. However, the motherboard hosting this slot may have that capability. This is important in order to support hot swapping of an adapter card in a system slot. The method should return 0 if successful, 1 if the request is not supported, and some other value if any other 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.
string SlotLayout ;
SlotLayout is a free-form string that describes the slot positioning, typical usage, restrictions, individual slot spacings or any other pertinent information for the slots on a Card.
ModelCorrespondence { "CIM_Card.RequirementsDescription" }
boolean SpecialRequirements ;
Boolean indicating that this Card is physically unique from other Cards of the same type and therefore requires a special Slot. For example, a double-wide Card requires two Slots. Another example is where a certain Card may be used for the same general function as other Cards but requires a special Slot (e.g., extra long), whereas the other Cards can be placed in any available Slot. If set to TRUE, then the corresponding property, RequirementsDescription, should specify the nature of the uniqueness or purpose of the Card.
boolean HostingBoard ;
Boolean indicating that this Card is a Motherboard or, more generically, a baseboard in a Chassis.
Units ( "MilliVolts" )
sint16 OperatingVoltages [ ] ;
Operating voltages required by the Card.
ModelCorrespondence { "CIM_Card.SpecialRequirements" }
string RequirementsDescription ;
A free-form string describing the way(s) in which this Card is physically unique from other Cards. This property only has meaning when the corresponding boolean property, SpecialRequirements, is set to TRUE.
Deprecated { "No Value" }
boolean Replaceable ;
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.
Units ( "Inches" )
real32 Height ;
The height of the PhysicalPackage in inches.
Units ( "Inches" )
real32 Width ;
The width of the PhysicalPackage in inches.
Units ( "Pounds" )
real32 Weight ;
The weight of the PhysicalPackage in pounds.
Deprecated { "No Value" }
uint32IsCompatible(
The element to check for compatibility with this one.
Qualifiers:IN
CIM_PhysicalElement REF ElementToCheck
)
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.
Deprecated { "CIM_PhysicalPackage.RemovalConditions" }
boolean HotSwappable ;
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.
Units ( "Inches" )
real32 Depth ;
The depth of the PhysicalPackage in inches.
ValueMap { "0" , "2" , "3" , "4" }
Values { "Unknown" , "Not Applicable" , "Removable when off" , "Removable when on or off" }
uint16 RemovalConditions = 2 ;
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'.
Deprecated { "CIM_PhysicalPackage.RemovalConditions" }
boolean Removable ;
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.
MappingStrings { "MIB.IETF|Entity-MIB.entPhysicalName" }
Override ( "ElementName" )
string ElementName ;
MappingStrings { "MIB.IETF|Entity-MIB.entPhysicalVendorType" }
string VendorEquipmentType ;
A vendor-specific hardware type for the PhysicalElement. It describes the specific equipment type for the element, as defined by the vendor or manufacturer.
MaxLen ( 256 )
MappingStrings { "MIB.IETF|Entity-MIB.entPhysicalDescr" , "MIF.DMTF|FRU|003.5" }
string Model ;
The name by which the PhysicalElement is generally known.
MaxLen ( 256 )
MappingStrings { "MIB.IETF|Entity-MIB.entPhysicalModelName" }
string PartNumber ;
The part number assigned by the organization that is responsible for producing or manufacturing the PhysicalElement.
MappingStrings { "MIB.IETF|Entity-MIB.entPhysicalIsFRU" }
boolean CanBeFRUed ;
Boolean that indicates whether this PhysicalElement can be FRUed (TRUE) or not (FALSE).
boolean PoweredOn ;
Boolean that indicates whether the PhysicalElement is powered on (TRUE) or is currently off (FALSE).
MaxLen ( 256 )
MappingStrings { "MIB.IETF|Entity-MIB.entPhysicalMfgName" , "MIF.DMTF|FRU|003.4" }
string Manufacturer ;
The name of the organization responsible for producing the PhysicalElement. This organization might 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.
MappingStrings { "MIB.IETF|Entity-MIB.entPhysicalAlias" }
Write
string OtherIdentifyingInfo ;
OtherIdentifyingInfo captures data in addition to Tag information. This information 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 or 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.
MaxLen ( 256 )
Key
string Tag ;
An arbitrary string that uniquely identifies the Physical Element and serves as the key of the Element. 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 or entity, regardless of physical placement in or on Cabinets, Adapters, and so on. For example, a hotswappable or removable component 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. Therefore, the key for Physical Element is an arbitrary string and is defined independently of any placement or location-oriented hierarchy.
MaxLen ( 256 )
MappingStrings { "MIB.IETF|Entity-MIB.entPhysicalSerialNum" , "MIF.DMTF|FRU|003.7" }
string SerialNumber ;
A manufacturer-allocated number used to identify the Physical Element.
MappingStrings { "MIB.IETF|Entity-MIB.entPhysicalAssetID" }
Write
string UserTracking ;
User-assigned and writeable asset-tracking identifier for the PhysicalElement.
MaxLen ( 64 )
MappingStrings { "MIB.IETF|Entity-MIB.entPhysicalHardwareRev" , "MIF.DMTF|FRU|003.8" }
string Version ;
A string that indicates the version of the PhysicalElement.
MaxLen ( 256 )
Key
string CreationClassName ;
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.
MappingStrings { "MIF.DMTF|FRU|003.3" }
Override ( "Description" )
string Description ;
A textual description of the PhysicalElement.
datetime ManufactureDate ;
The date that this PhysicalElement was manufactured.
MaxLen ( 64 )
string SKU ;
The stock-keeping unit number for this PhysicalElement.
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , "15" , "16" , "17" , "18" , ".." , "0x8000.." }
ArrayType ( "Indexed" )
Values { "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 Reserved" }
ModelCorrespondence { "CIM_ManagedSystemElement.StatusDescriptions" }
uint16 OperationalStatus [ ] ;
Indicates the current statuses of the element. Various operational statuses are defined. Many of the enumeration's values are self-explanatory. However, a few are not and are described here in more detail.
'Stressed' indicates that the element is functioning, but needs attention. Examples of 'Stressed' states are overload, overheated, and so on.
'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 state and configuration of the element might need to be updated.
'Dormant' indicates that the element is inactive or quiesced.
'Supporting Entity in Error' indicates that this element might 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 that the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error).
'Power Mode' indicates that 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 because it required the deprecated qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly recommended that providers or 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 (because it is single-valued) should also provide the primary status of the element.
ArrayType ( "Indexed" )
ModelCorrespondence { "CIM_ManagedSystemElement.OperationalStatus" }
string StatusDescriptions [ ] ;
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.
ValueMap { "OK" , "Error" , "Degraded" , "Unknown" , "Pred Fail" , "Starting" , "Stopping" , "Service" , "Stressed" , "NonRecover" , "No Contact" , "Lost Comm" , "Stopped" }
MaxLen ( 10 )
Deprecated { "CIM_ManagedSystemElement.OperationalStatus" }
string Status ;
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 definition overcomes the limitation of describing status using a single value, when it is really a multi-valued property (for example, an element might be OK AND Stopped.
2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values.
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.
MappingStrings { "MIF.DMTF|ComponentID|001.5" }
datetime InstallDate ;
A datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed.
MaxLen ( 1024 )
string Name ;
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.
ValueMap { "0" , "5" , "10" , "15" , "20" , "25" , "30" , ".." }
Values { "Unknown" , "OK" , "Degraded/Warning" , "Minor failure" , "Major failure" , "Critical failure" , "Non-recoverable error" , "DMTF Reserved" }
uint16 HealthState ;
Indicates the current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely non-functional. The following continuum is defined:
'Non-recoverable Error' (30) - The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost.
'Critical Failure' (25) - The element is non-functional and recovery might not be possible.
'Major Failure' (20) - The element is failing. It is possible that some or all of the functionality of this component is degraded or not working.
'Minor Failure' (15) - All functionality is available but some might be degraded.
'Degraded/Warning' (10) - The element is in working order and all functionality is provided. However, the element is not working to the best of its abilities. For example, the element might not be operating at optimal performance or it might be reporting recoverable errors.
'OK' (5) - The element is fully functional and is operating within normal operational parameters and without error.
'Unknown' (0) - The implementation cannot report on HealthState at this time.
DMTF has reserved the unused portion of the continuum for additional HealthStates in the future.
MaxLen ( 64 )
string Caption ;
The Caption property is a short textual description (one- line string) of the object.