CIM2.17.1 Class Declaration
CIM_PrintSupply

Table of Contents:
Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary

Class Hierarchy

CIM_PrintSupply --> CIM_PrinterElement --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_PrinterElement
NAMECIM_PrintSupply

Class Qualifiers

Class CIM_PrintSupply Qualifiers
NameTypeValueFrom Class
ExperimentalbooleantrueCIM_PrintSupply
Versionstring2.17.0CIM_PrintSupply
UMLPackagePathstringCIM::Device::PrintingCIM_PrintSupply
DescriptionstringThis class represents a PrintSupply for a PrintMarker or PrintFinisher component of a Printer (print device). It contains a property that specifies if this instance represents a PrintSupply represents a container (for a supply that is consumed) or a receptacle (for waste that is produced). It also contains properties that describe the PrintSupply type, capacity, and remaining capacity. For PrintMarker colorants, it also contains properties that describe colorant role (spot or process), name, and tonality. Note: A PrintSupply shall be associated with exactly one Printer via an instance of the PrinterComponent class. A PrintSupply shall be associated with exactly one PrintMarker or PrintFinisher via an instance of AssociatedPrintSupply class. See: Model in section 2 of Printer MIB (RFC 3805) and section 3 of Finisher MIB (RFC 3806).CIM_PrintSupply
MappingStringsstringMIB.IETF|Printer-MIB.prtMarkerSuppliesEntry
MIB.IETF|Printer-MIB.prtMarkerColorantEntry
MIB.IETF|Finisher-MIB.finSupplyEntry
CIM_PrintSupply
UMLPackagePathstringCIM::Device::PrintingCIM_PrinterElement
DescriptionstringThis class extends LogicalElement to abstract the concept of a PrinterElement that is a component (e.g., PrintMarker) of a scoping Printer (print device). This class defines common properties for key (InstanceID) and for correlation of status and event (alert) information between CIM and SNMP management interfaces (SNMPRowId). Note: A PrinterElement shall be associated with exactly one Printer via an instance of the PrinterComponent class. See: Model in section 2 of Printer MIB (RFC 3805) and section 3 of Finisher MIB (RFC 3806).CIM_PrinterElement
UMLPackagePathstringCIM::Core::CoreElementsCIM_LogicalElement
DescriptionstringCIM_LogicalElement is a base class for all the components of a System that represent abstract system components, such as Files, Processes, or LogicalDevices.CIM_LogicalElement
UMLPackagePathstringCIM::Core::CoreElementsCIM_ManagedSystemElement
DescriptionstringCIM_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
UMLPackagePathstringCIM::Core::CoreElementsCIM_ManagedElement
DescriptionstringManagedElement 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

Properties

Properties
NameTypeValueQualifiersClassOrigin
LocalizedDescriptionstring Description
MinLen
MaxLen
MappingStrings
CIM_PrintSupply
Classificationuint32 Description
ValueMap
Values
MappingStrings
ModelCorrespondence
CIM_PrintSupply
OtherClassificationstring Description
MinLen
MaxLen
ModelCorrespondence
CIM_PrintSupply
Typeuint32 Description
ValueMap
Values
MappingStrings
ModelCorrespondence
CIM_PrintSupply
OtherTypeDescriptionstring Description
MinLen
MaxLen
ModelCorrespondence
CIM_PrintSupply
SupplyUnituint32 Description
ValueMap
Values
MappingStrings
ModelCorrespondence
CIM_PrintSupply
OtherSupplyUnitstring Description
MinLen
MaxLen
ModelCorrespondence
CIM_PrintSupply
MaxCapacityBasisuint16 Description
ValueMap
Values
MappingStrings
ModelCorrespondence
CIM_PrintSupply
MaxCapacityuint32 Description
MinValue
MaxValue
MappingStrings
ModelCorrespondence
CIM_PrintSupply
RemainingCapacityBasisuint16 Description
ValueMap
Values
MappingStrings
ModelCorrespondence
CIM_PrintSupply
RemainingCapacityuint32 Description
MinValue
MaxValue
MappingStrings
ModelCorrespondence
CIM_PrintSupply
ColorantRoleuint32 Description
ValueMap
Values
MappingStrings
ModelCorrespondence
CIM_PrintSupply
OtherColorantRolestring Description
MinLen
MaxLen
ModelCorrespondence
CIM_PrintSupply
ColorantNameuint16 Description
ValueMap
Values
MappingStrings
ModelCorrespondence
CIM_PrintSupply
OtherColorantNamestring Description
MinLen
MaxLen
ModelCorrespondence
CIM_PrintSupply
ColorantTonalityuint32 Description
MinValue
MaxValue
MappingStrings
CIM_PrintSupply
InstanceIDstring Key
Description
CIM_PrinterElement
SNMPRowIduint32 Description
MinValue
MaxValue
MappingStrings
CIM_PrinterElement
InstallDatedatetime Description
MappingStrings
CIM_ManagedSystemElement
Namestring Description
MaxLen
CIM_ManagedSystemElement
OperationalStatusuint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
StatusDescriptionsstring[] Description
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
Statusstring Deprecated
Description
ValueMap
MaxLen
CIM_ManagedSystemElement
HealthStateuint16 Description
ValueMap
Values
CIM_ManagedSystemElement
PrimaryStatusuint16 Experimental
Description
ValueMap
Values
ModelCorrespondence
CIM_ManagedSystemElement
DetailedStatusuint16 Experimental
Description
ValueMap
Values
ModelCorrespondence
CIM_ManagedSystemElement
OperatingStatusuint16 Experimental
Description
ValueMap
Values
ModelCorrespondence
CIM_ManagedSystemElement
CommunicationStatusuint16 Experimental
Description
ValueMap
Values
CIM_ManagedSystemElement
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement
ElementNamestring Description CIM_ManagedElement

Property Qualifiers

Property LocalizedDescription Qualifiers
NameTypeValueFrom Class
DescriptionstringA free-form text description of this PrintSupply in the localization specified by CIM_Printer.CurrentNaturalLanguage.CIM_PrintSupply
MinLenuint320CIM_PrintSupply
MaxLenuint32255CIM_PrintSupply
MappingStringsstringMIB.IETF|Printer-MIB.prtMarkerSuppliesDescription
MIB.IETF|Finisher-MIB.finSupplyDescription
MIB.IETF|Printer-MIB.PrtLocalizedDescriptionStringTC
CIM_PrintSupply

Property Classification Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates whether this PrintSupply instance represents a PrintSupply that is consumed or a receptacle that is filled.CIM_PrintSupply
ValueMapstring
[See below.]
CIM_PrintSupply
ValuesstringOther
SupplyThatIsConsumed
ReceptacleThatIsFilled
DMTF Reserved
CIM_PrintSupply
MappingStringsstringMIB.IETF|Printer-MIB.prtMarkerSuppliesClass
MIB.IETF|Finisher-MIB.finSupplyClass
MIB.IETF|Printer-MIB.PrtMarkerSuppliesClassTC
CIM_PrintSupply
ModelCorrespondencestringCIM_PrintSupply.OtherClassificationCIM_PrintSupply

NameValue
1Other
3SupplyThatIsConsumed
4ReceptacleThatIsFilled
..DMTF Reserved
Property OtherClassification Qualifiers
NameTypeValueFrom Class
DescriptionstringA free-form string that describes the PrintSupply classification when the value of the Classification property is equal to 1 (Other).CIM_PrintSupply
MinLenuint320CIM_PrintSupply
MaxLenuint32255CIM_PrintSupply
ModelCorrespondencestringCIM_PrintSupply.ClassificationCIM_PrintSupply

Property Type Qualifiers
NameTypeValueFrom Class
DescriptionstringThe type of this PrintSupply.CIM_PrintSupply
ValueMapstring
[See below.]
CIM_PrintSupply
ValuesstringOther
Unknown
Toner
WasteToner
Ink
InkCartridge
InkRibbon
WasteInk
Opc
Developer
FuserOil
SolidWax
RibbonWax
WasteWax
Fuser
CoronaWire
FuserOilWick
CleanerUnit
FuserCleaningPad
TransferUnit
TonerCartridge
FuserOiler
Water
WasteWater
GlueWaterAdditive
WastePaper
BindingSupply
BandingSupply
StitchingWire
ShrinkWrap
PaperWrap
Staples
Inserts
Covers
DMTF Reserved
CIM_PrintSupply
MappingStringsstringMIB.IETF|Printer-MIB.prtMarkerSuppliesType
MIB.IETF|Finisher-MIB.finSupplyType
MIB.IETF|IANA-PRINTER-MIB.PrtMarkerSuppliesTypeTC
CIM_PrintSupply
ModelCorrespondencestringCIM_PrintSupply.OtherTypeDescriptionCIM_PrintSupply

NameValue
1Other
2Unknown
3Toner
4WasteToner
5Ink
6InkCartridge
7InkRibbon
8WasteInk
9Opc
10Developer
11FuserOil
12SolidWax
13RibbonWax
14WasteWax
15Fuser
16CoronaWire
17FuserOilWick
18CleanerUnit
19FuserCleaningPad
20TransferUnit
21TonerCartridge
22FuserOiler
23Water
24WasteWater
25GlueWaterAdditive
26WastePaper
27BindingSupply
28BandingSupply
29StitchingWire
30ShrinkWrap
31PaperWrap
32Staples
33Inserts
34Covers
..DMTF Reserved
Property OtherTypeDescription Qualifiers
NameTypeValueFrom Class
DescriptionstringA free-form string that describes the PrintSupply type when the value of the Type property is equal to 1 (Other).CIM_PrintSupply
MinLenuint320CIM_PrintSupply
MaxLenuint32255CIM_PrintSupply
ModelCorrespondencestringCIM_PrintSupply.TypeCIM_PrintSupply

Property SupplyUnit Qualifiers
NameTypeValueFrom Class
DescriptionstringUnit of measure for this PrintSupply container (for a supply that is consumed) or receptacle (for waste that is produced).CIM_PrintSupply
ValueMapstring
[See below.]
CIM_PrintSupply
ValuesstringOther
Unknown
TenThousandthsOfInches
Micrometers
Impressions
Sheets
Hours
ThousandthsOfOunces
TenthsOfGrams
HundrethsOfFluidOunces
TenthsOfMilliliters
Feet
Meters
Items
Percent
DMTF Reserved
CIM_PrintSupply
MappingStringsstringMIB.IETF|Printer-MIB.prtMarkerSuppliesSupplyUnit
MIB.IETF|Finisher-MIB.finSupplyUnit
MIB.IETF|Printer-MIB.PrtMarkerSuppliesSupplyUnitTC
CIM_PrintSupply
ModelCorrespondencestringCIM_PrintSupply.OtherSupplyUnitCIM_PrintSupply

NameValue
1Other
2Unknown
3TenThousandthsOfInches
4Micrometers
7Impressions
8Sheets
11Hours
12ThousandthsOfOunces
13TenthsOfGrams
14HundrethsOfFluidOunces
15TenthsOfMilliliters
16Feet
17Meters
18Items
19Percent
..DMTF Reserved
Property OtherSupplyUnit Qualifiers
NameTypeValueFrom Class
DescriptionstringA free-form string that describes the PrintSupply unit when the value of the SupplyUnit property is equal to 1 (Other).CIM_PrintSupply
MinLenuint320CIM_PrintSupply
MaxLenuint32255CIM_PrintSupply
ModelCorrespondencestringCIM_PrintSupply.SupplyUnitCIM_PrintSupply

Property MaxCapacityBasis Qualifiers
NameTypeValueFrom Class
DescriptionstringThe basis for the limit property MaxCapacity, that specifies whether a meaningful value is available. 1 (Other) means the Printer places no restrictions on capacity and MaxCapacity shall be null. 2 (Unknown) means the Printer cannot sense a meaningful value and MaxCapacity shall be null. 3 (Actual) means the Printer can sense a meaningful value and MaxCapacity shall be present.CIM_PrintSupply
ValueMapstring
[See below.]
CIM_PrintSupply
ValuesstringOther
Unknown
Actual
DMTF Reserved
CIM_PrintSupply
MappingStringsstringMIB.IETF|Printer-MIB.prtMarkerSuppliesMaxCapacity
MIB.IETF|Finisher-MIB.finSuppyMaxCapacity
CIM_PrintSupply
ModelCorrespondencestringCIM_PrintSupply.MaxCapacityCIM_PrintSupply

NameValue
1Other
2Unknown
3Actual
..DMTF Reserved
Property MaxCapacity Qualifiers
NameTypeValueFrom Class
DescriptionstringThe maximum capacity of this PrintSupply container (for a supply that is consumed) or receptacle (for waste that is produced) in units specified by CIM_PrintSupply.SupplyUnit. If this Printer can reliably sense this value, the value is sensed by the Printer and cannot be changed by the system administrator; otherwise, the value may be changed out-of-band by the system administrator.CIM_PrintSupply
MinValuesint640CIM_PrintSupply
MaxValuesint642147483647CIM_PrintSupply
MappingStringsstringMIB.IETF|Printer-MIB.prtMarkerSuppliesMaxCapacity
MIB.IETF|Finisher-MIB.finSuppyMaxCapacity
MIB.IETF|Printer-MIB.prtMarkerSuppliesSupplyUnit
MIB.IETF|Finisher-MIB.finSupplyUnit
MIB.IETF|Printer-MIB.PrtMarkerSuppliesSupplyUnitTC
CIM_PrintSupply
ModelCorrespondencestringCIM_PrintSupply.MaxCapacityBasisCIM_PrintSupply

Property RemainingCapacityBasis Qualifiers
NameTypeValueFrom Class
DescriptionstringThe basis for the gauge property RemainingCapacity, that specifies whether a meaningful value is available. 1 (Other) means the Printer places no restrictions on capacity and RemainingCapacity shall be null. 2 (Unknown) means the Printer cannot sense a meaningful value and RemainingCapacity shall be null. 3 (Actual) means the Printer can sense a meaningful value and RemainingCapacity shall be present. 4 (AtLeastOne) means that the Printer can only sense that at least one capacity unit remains and RemainingCapacity shall be present and shall contain the value zero or one.CIM_PrintSupply
ValueMapstring
[See below.]
CIM_PrintSupply
ValuesstringOther
Unknown
Actual
AtLeastOne
DMTF Reserved
CIM_PrintSupply
MappingStringsstringMIB.IETF|Printer-MIB.prtMarkerSuppliesLevel
MIB.IETF|Finisher-MIB.finSuppyCurrentLevel
CIM_PrintSupply
ModelCorrespondencestringCIM_PrintSupply.RemainingCapacityCIM_PrintSupply

NameValue
1Other
2Unknown
3Actual
4AtLeastOne
..DMTF Reserved
Property RemainingCapacity Qualifiers
NameTypeValueFrom Class
DescriptionstringThe current remaining level of the supply if this PrintSupply is a container (for a supply that is consumed) or the remaining capacity if this PrintSupply is a receptacle (for waste that is produced), in units specified by CIM_PrintSupply.SupplyUnit. If this Printer can reliably sense this value, the value is sensed by the Printer and cannot be changed by the system administrator; otherwise, the value may be changed out-of-band by the system administrator.CIM_PrintSupply
MinValuesint640CIM_PrintSupply
MaxValuesint642147483647CIM_PrintSupply
MappingStringsstringMIB.IETF|Printer-MIB.prtMarkerSuppliesLevel
MIB.IETF|Finisher-MIB.finSuppyCurrentLevel
MIB.IETF|Printer-MIB.prtMarkerSuppliesSupplyUnit
MIB.IETF|Finisher-MIB.finSupplyUnit
MIB.IETF|Printer-MIB.PrtMarkerSuppliesSupplyUnitTC
CIM_PrintSupply
ModelCorrespondencestringCIM_PrintSupply.RemainingCapacityBasisCIM_PrintSupply

Property ColorantRole Qualifiers
NameTypeValueFrom Class
DescriptionstringIf this PrintSupply does not represent a PrintMarker colorant, then this property shall be null. If this PrintSupply does represent a PrintMarker colorant, then this property shall be present and shall denote the role played by this PrintMarker colorant.CIM_PrintSupply
ValueMapstring
[See below.]
CIM_PrintSupply
ValuesstringOther
Process
Spot
DMTF Reserved
CIM_PrintSupply
MappingStringsstringMIB.IETF|Printer-MIB.prtMarkerColorantRole
MIB.IETF|Printer-MIB.PrtMarkerColorantRoleTC
CIM_PrintSupply
ModelCorrespondencestringCIM_PrintMarker.OtherColorantRole
CIM_PrintMarker.ProcessColorants
CIM_PrintMarker.SpotColorants
CIM_PrintSupply

NameValue
1Other
3Process
4Spot
..DMTF Reserved
Property OtherColorantRole Qualifiers
NameTypeValueFrom Class
DescriptionstringIf this PrintSupply does not represent a PrintMarker colorant, then this property shall be null. If this PrintSupply does represent a PrintMarker colorant and the value of the ColorantRole property is equal to 1 (Other), then this property shall be present and shall contain a free-form string that describes the role of the colorant.CIM_PrintSupply
MinLenuint320CIM_PrintSupply
MaxLenuint32255CIM_PrintSupply
ModelCorrespondencestringCIM_PrintMarker.ColorantRoleCIM_PrintSupply

Property ColorantName Qualifiers
NameTypeValueFrom Class
DescriptionstringIf this PrintSupply does not represent a PrintMarker colorant, then this property shall be null. If this PrintSupply does represent a PrintMarker colorant, then this property shall be present and shall denote the colorant name using the standardized names from ISO 10175 (DPA) and ISO 10180 (SPDL). Vendors and administrators may specify other colorant names in the OtherColorantName property.CIM_PrintSupply
ValueMapstring
[See below.]
CIM_PrintSupply
ValuesstringOther
Unknown
White
Red
Green
Blue
Cyan
Magenta
Yellow
Black
DMTF Reserved
CIM_PrintSupply
MappingStringsstringMIB.IETF|Printer-MIB.prtMarkerColorantValueCIM_PrintSupply
ModelCorrespondencestringCIM_PrintSupply.OtherColorantNameCIM_PrintSupply

NameValue
1Other
2Unknown
3White
4Red
5Green
6Blue
7Cyan
8Magenta
9Yellow
10Black
..DMTF Reserved
Property OtherColorantName Qualifiers
NameTypeValueFrom Class
DescriptionstringIf this PrintSupply does not represent a PrintMarker colorant, then this property shall be null. If this PrintSupply does represent a PrintMarker colorant and the value of the ColorantName property is equal to 1 (Other), then this property shall be present and shall contain a vendor or administrator defined value. The naming conventions in ISO 9070 are recommended in order to avoid potential name clashes.CIM_PrintSupply
MinLenuint320CIM_PrintSupply
MaxLenuint32255CIM_PrintSupply
ModelCorrespondencestringCIM_PrintSupply.ColorantNameCIM_PrintSupply

Property ColorantTonality Qualifiers
NameTypeValueFrom Class
DescriptionstringIf this PrintSupply does not represent a PrintMarker colorant, then this property shall be null. If this PrintSupply does represent a PrintMarker colorant, then this property shall be present and shall denote the distinct levels of tonality realizable by a PrintMarker when using this colorant. This value does not include the number of levels of tonal difference that an interpreter can obtain by techniques such as half toning. This value must be at least 2.CIM_PrintSupply
MinValuesint642CIM_PrintSupply
MaxValuesint642147483647CIM_PrintSupply
MappingStringsstringMIB.IETF|Printer-MIB.prtMarkerColorantTonalityCIM_PrintSupply

Property InstanceID Qualifiers
NameTypeValueFrom Class
KeybooleantrueCIM_PrinterElement
DescriptionstringWithin the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm: <OrgID>:<LocalID>Where <OrgID> and <LocalID> are separated by a colon (:), and where <OrgID> shall include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness, <OrgID> shall not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID shall appear between <OrgID> and <LocalID>. <LocalID> is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If the above "preferred" algorithm is not used, the defining entity shall assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. For DMTF-defined instances, the "preferred" algorithm entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness, <OrgID> shall not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID shall appear between <OrgID> and <LocalID>. <LocalID> is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If the above "preferred" algorithm is not used, the defining entity shall assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. For DMTF-defined instances, the "preferred" algorithm shall be used with the <OrgID> set to CIM.CIM_PrinterElement

Property SNMPRowId Qualifiers
NameTypeValueFrom Class
DescriptionstringA unique value used by a scoping Printer to identify this component (e.g., PrintMarker) of the scoping Printer. Although these values may change due to a reconfiguration of the Printer (e.g., the addition of new components to the Printer), values should remain stable across successive Printer power cycles. Note: This property is necessary to correlate status and event (alert) information between CIM and SNMP interfaces.CIM_PrinterElement
MinValuesint641CIM_PrinterElement
MaxValuesint6465535CIM_PrinterElement
MappingStringsstringMIB.IETF|Printer-MIB.prtCoverIndex
MIB.IETF|Printer-MIB.prtInputIndex
MIB.IETF|Printer-MIB.prtOutputIndex
MIB.IETF|Printer-MIB.prtMarkerIndex
MIB.IETF|Printer-MIB.prtMarkerSuppliesIndex
MIB.IETF|Printer-MIB.prtMediaPathIndex
MIB.IETF|Printer-MIB.prtChannelIndex
MIB.IETF|Printer-MIB.prtInterpreterIndex
MIB.IETF|Printer-MIB.prtConsoleLightIndex
MIB.IETF|Finisher-MIB.finDeviceIndex
MIB.IETF|Finisher-MIB.finSupplyIndex
CIM_PrinterElement

Property InstallDate Qualifiers
NameTypeValueFrom Class
DescriptionstringA datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed.CIM_ManagedSystemElement
MappingStringsstringMIF.DMTF|ComponentID|001.5CIM_ManagedSystemElement

Property Name Qualifiers
NameTypeValueFrom Class
DescriptionstringThe 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
MaxLenuint321024CIM_ManagedSystemElement

Property OperationalStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates 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.CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
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
CIM_ManagedSystemElement
ArrayTypestringIndexedCIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptionsCIM_ManagedSystemElement

NameValue
0Unknown
1Other
2OK
3Degraded
4Stressed
5Predictive Failure
6Error
7Non-Recoverable Error
8Starting
9Stopping
10Stopped
11In Service
12No Contact
13Lost Communication
14Aborted
15Dormant
16Supporting Entity in Error
17Completed
18Power Mode
..DMTF Reserved
0x8000..Vendor Reserved
Property StatusDescriptions Qualifiers
NameTypeValueFrom Class
DescriptionstringStrings 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
ArrayTypestringIndexedCIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatusCIM_ManagedSystemElement

Property Status Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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.CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
MaxLenuint3210CIM_ManagedSystemElement

NameValue
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 HealthState Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates 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.CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
OK
Degraded/Warning
Minor failure
Major failure
Critical failure
Non-recoverable error
DMTF Reserved
CIM_ManagedSystemElement

NameValue
0Unknown
5OK
10Degraded/Warning
15Minor failure
20Major failure
25Critical failure
30Non-recoverable error
..DMTF Reserved
Property PrimaryStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringPrimaryStatus provides a high level status value, intended to align with Red-Yellow-Green type representation of status. It should be used in conjunction with DetailedStatus to provide high level and detailed health status of the ManagedElement and its subcomponents. PrimaryStatus consists of one of the following values: Unknown, OK, Degraded or Error. "Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time. "OK" indicates the ManagedElement is functioning normally. "Degraded" indicates the ManagedElement is functioning below normal. "Error" indicates the ManagedElement is in an Error condition.CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
OK
Degraded
Error
DMTF Reserved
Vendor Reserved
CIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.DetailedStatus
CIM_ManagedSystemElement.HealthState
CIM_ManagedSystemElement

NameValue
0Unknown
1OK
2Degraded
3Error
..DMTF Reserved
0x8000..Vendor Reserved
Property DetailedStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringDetailedStatus compliments PrimaryStatus with additional status detail. It consists of one of the following values: Not Available, No Additional Information, Stressed, Predictive Failure, Error, Non-Recoverable Error, SupportingEntityInError. Detailed status is used to expand upon the PrimaryStatus of the element. A Null return indicates the implementation (provider) does not implement this property. "Not Available" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property). "No Additional Information" indicates that the element is functioning normally as indicated by PrimaryStatus = "OK". "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 normally but a failure is predicted in the near future. "Non-Recoverable Error " indicates that this element is in an error condition that requires human intervention. "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.CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringNot Available
No Additional Information
Stressed
Predictive Failure
Non-Recoverable Error
Supporting Entity in Error
DMTF Reserved
Vendor Reserved
CIM_ManagedSystemElement
ModelCorrespondencestringCIM_EnabledLogicalElement.PrimaryStatus
CIM_ManagedSystemElement.HealthState
CIM_ManagedSystemElement

NameValue
0Not Available
1No Additional Information
2Stressed
3Predictive Failure
4Non-Recoverable Error
5Supporting Entity in Error
..DMTF Reserved
0x8000..Vendor Reserved
Property OperatingStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringOperatingStatus provides a current status value for the operational condition of the element and can be used for providing more detail with respect to the value of EnabledState. It can also provide the transitional states when an element is transitioning from one state to another, such as when an element is transitioning between EnabledState and RequestedState, as well as other transitional conditions.OperatingStatus consists of one of the following values: Unknown, Not Available, In Service, Starting, Stopping, Stopped, Aborted, Dormant, Completed, Migrating, Emmigrating, Immigrating, Snapshotting. Shutting Down, In Test A Null return indicates the implementation (provider) does not implement this property. "Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time. "None" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property). "Servicing" describes an element being configured, maintained, cleaned, or otherwise administered. "Starting" describes an element being initialized. "Stopping" describes an element being brought to an orderly stop. "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. "Completed" indicates that the element has completed its operation. This value should be combined with either OK, Error, or Degraded in the PrimaryStatus 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). "Migrating" element is being moved between host elements. "Immigrating" element is being moved to new host element. "Emigrating" element is being moved away from host element. "Shutting Down" describes an element being brought to an abrupt stop. "In Test" element is performing test functions. "Transitioning" describes an element that is between states, that is, it is not fully available in either its previous state or its next state. This value should be used if other values indicating a transition to a specific state are not applicable."In Service" describes an element that is in service and operational.CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
Not Available
Servicing
Starting
Stopping
Stopped
Aborted
Dormant
Completed
Migrating
Emigrating
Immigrating
Snapshotting
Shutting Down
In Test
Transitioning
In Service
DMTF Reserved
Vendor Reserved
CIM_ManagedSystemElement
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledStateCIM_ManagedSystemElement

NameValue
0Unknown
1Not Available
2Servicing
3Starting
4Stopping
5Stopped
6Aborted
7Dormant
8Completed
9Migrating
10Emigrating
11Immigrating
12Snapshotting
13Shutting Down
14In Test
15Transitioning
16In Service
..DMTF Reserved
0x8000..Vendor Reserved
Property CommunicationStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringCommunicationStatus indicates the ability of the instrumentation to communicate with the underlying ManagedElement. CommunicationStatus consists of one of the following values: Unknown, None, Communication OK, Lost Communication, or No Contact. A Null return indicates the implementation (provider) does not implement this property. "Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time. "Not Available" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property). "Communication OK " indicates communication is established with the element, but does not convey any quality of service. "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 Managed Element is known to exist and has been contacted successfully in the past, but is currently unreachable.CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
Not Available
Communication OK
Lost Communication
No Contact
DMTF Reserved
Vendor Reserved
CIM_ManagedSystemElement

NameValue
0Unknown
1Not Available
2Communication OK
3Lost Communication
4No Contact
..DMTF Reserved
0x8000..Vendor Reserved
NameValue
0Unknown
1Not Available
2Communication OK
3Lost Communication
4No Contact
..DMTF Reserved
0x8000..Vendor Reserved
NameValue
0Unknown
1Not Available
2Communication OK
3Lost Communication
4No Contact
..DMTF Reserved
0x8000..Vendor Reserved
NameValue
0Unknown
1Not Available
2Communication OK
3Lost Communication
4No Contact
..DMTF Reserved
0x8000..Vendor Reserved
Property Caption Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Caption property is a short textual description (one- line string) of the object.CIM_ManagedElement
MaxLenuint3264CIM_ManagedElement

Property Description Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Description property provides a textual description of the object.CIM_ManagedElement

Property ElementName Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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 the Name property of ManagedSystemElement 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 can be present in both the Name and ElementName properties.CIM_ManagedElement

Methods

Method Qualifiers

Parameters

Parameter Qualifiers

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_AssociatedPrintSupplyCIM_PrintSupplyAntecedent
CIM_PrinterComponentCIM_PrinterElementPartComponent
CIM_AssociatedPrintSupplyCIM_PrinterElementDependent
CIM_LogicalElementPerformsUoWCIM_LogicalElementAntecedent
CIM_ImportedShareRootCIM_LogicalElementAntecedent
CIM_ImportedShareRootCIM_LogicalElementDependent
CIM_ElementAllocatedFromPoolCIM_LogicalElementDependent
CIM_AllocatedFromStoragePoolCIM_LogicalElementDependent
CIM_LogicalElementUnitOfWorkDefCIM_LogicalElementAntecedent
CIM_ResidesOnExtentCIM_LogicalElementDependent
CIM_SharedElementRootCIM_LogicalElementAntecedent
CIM_OperationLogCIM_LogicalElementDependent
CIM_AssociatedMemoryCIM_LogicalElementDependent
CIM_AssociatedCacheMemoryCIM_LogicalElementDependent
CIM_AttachedElementCIM_LogicalElementSystemElement
CIM_AttachedElementCIM_LogicalElementSameElement
CIM_MountedElementCIM_LogicalElementSystemElement
CIM_MountedElementCIM_LogicalElementSameElement
CIM_ImportedShareCIM_LogicalElementSystemElement
CIM_ImportedShareCIM_LogicalElementSameElement
CIM_SharedElementCIM_LogicalElementSystemElement
CIM_DiagnosticResultForMSECIM_ManagedSystemElementSystemElement
CIM_RedundancyComponentCIM_ManagedSystemElementPartComponent
CIM_SystemComponentCIM_ManagedSystemElementPartComponent
CIM_SuppliesPowerCIM_ManagedSystemElementDependent
CIM_UseOfLogCIM_ManagedSystemElementDependent
CIM_UseOfMessageLogCIM_ManagedSystemElementDependent
CIM_DiagnosticTestForMSECIM_ManagedSystemElementDependent
CIM_AssociatedCoolingCIM_ManagedSystemElementDependent
CIM_AssociatedIndicatorLEDCIM_ManagedSystemElementAntecedent
CIM_AssociatedSensorCIM_ManagedSystemElementDependent
CIM_AssociatedBatteryCIM_ManagedSystemElementDependent
CIM_ElementConfigurationCIM_ManagedSystemElementElement
CIM_CollectedMSEsCIM_ManagedSystemElementMember
CIM_ActsAsSpareCIM_ManagedSystemElementSpare
CIM_ElementSettingCIM_ManagedSystemElementElement
CIM_DefaultSettingCIM_ManagedSystemElementElement
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_SettingsDefineStateCIM_ManagedElementManagedElement
CIM_StatisticsCIM_ManagedElementElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement
CIM_AuthorizationRuleAppliesToTargetCIM_ManagedElementManagedElement
CIM_CredentialContextCIM_ManagedElementElementProvidingContext
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_OrderedComponentCIM_ManagedElementGroupComponent
CIM_OrderedComponentCIM_ManagedElementPartComponent
CIM_ProductElementComponentCIM_ManagedElementPartComponent
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_OrderedDependencyCIM_ManagedElementAntecedent
CIM_OrderedDependencyCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementDependent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_IsSpareCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SWRManageableAspectCIM_ManagedElementSystemElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_OrderedMemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_MemberOfStatusCollectionCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_OwningCollectionElementCIM_ManagedElementOwningElement
CIM_AbstractIndicationSubscriptionCIM_ManagedElementFilter
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_DefaultElementCapabilitiesCIM_ManagedElementManagedElement
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_RoleLimitedToTargetCIM_ManagedElementTargetElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_AvailableDiagnosticServiceCIM_ManagedElementUserOfService
CIM_AssociatedPowerManagementServiceCIM_ManagedElementUserOfService
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ManagementSAPCIM_ManagedElementManagedElement