# Class CIM_PrintSupply
extends CIM_PrinterElement

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

### Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

## Class Hierarchy

CIM_ManagedElement
|
+--CIM_ManagedSystemElement
|
+--CIM_LogicalElement
|
+--CIM_PrinterElement
|
+--CIM_PrintSupply

## Direct Known Subclasses

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---

Description

string

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

MappingStrings | string | MIB.IETF|Printer-MIB.prtMarkerSuppliesEntry, MIB.IETF|Printer-MIB.prtMarkerColorantEntry, MIB.IETF|Finisher-MIB.finSupplyEntry
UMLPackagePath | string | CIM::Device::Printing
Version | string | 2.31.1

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
Classification | uint32 |
Description | string | Indicates whether this PrintSupply instance represents a PrintSupply that is consumed or a receptacle that is filled.
MappingStrings | string | MIB.IETF|Printer-MIB.prtMarkerSuppliesClass, MIB.IETF|Finisher-MIB.finSupplyClass, MIB.IETF|Printer-MIB.PrtMarkerSuppliesClassTC
ModelCorrespondence | string | CIM_PrintSupply.OtherClassification
ValueMap | string | 1, 3, 4, ..
Values | string | Other, SupplyThatIsConsumed, ReceptacleThatIsFilled, DMTF Reserved
ColorantName | uint16 |

Description

string

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

MappingStrings | string | MIB.IETF|Printer-MIB.prtMarkerColorantValue
ModelCorrespondence | string | CIM_PrintSupply.OtherColorantName
ValueMap | string | 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, ..
Values | string | Other, Unknown, White, Red, Green, Blue, Cyan, Magenta, Yellow, Black, DMTF Reserved
ColorantRole | uint32 |
Description | string | If 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.
MappingStrings | string | MIB.IETF|Printer-MIB.prtMarkerColorantRole, MIB.IETF|Printer-MIB.PrtMarkerColorantRoleTC
ModelCorrespondence | string | CIM_PrintSupply.OtherColorantRole, CIM_PrintMarker.ProcessColorants, CIM_PrintMarker.SpotColorants
ValueMap | string | 1, 3, 4, ..
Values | string | Other, Process, Spot, DMTF Reserved
ColorantTonality | uint32 |

Description

string

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

MappingStrings | string | MIB.IETF|Printer-MIB.prtMarkerColorantTonality
MaxValue | sint64 | 2147483647
MinValue | sint64 | 2
LocalizedDescription | string |
Description | string | A free-form text description of this PrintSupply in the localization specified by CIM_Printer.CurrentNaturalLanguage.
MappingStrings | string | MIB.IETF|Printer-MIB.prtMarkerSuppliesDescription, MIB.IETF|Finisher-MIB.finSupplyDescription, MIB.IETF|Printer-MIB.PrtLocalizedDescriptionStringTC
MaxLen | uint32 | 255
ModelCorrespondence | string | CIM_Printer.CurrentNaturalLanguage
MaxCapacity | uint32 |

Description

string

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

MappingStrings | string | MIB.IETF|Printer-MIB.prtMarkerSuppliesMaxCapacity, MIB.IETF|Finisher-MIB.finSuppyMaxCapacity, MIB.IETF|Printer-MIB.prtMarkerSuppliesSupplyUnit, MIB.IETF|Finisher-MIB.finSupplyUnit, MIB.IETF|Printer-MIB.PrtMarkerSuppliesSupplyUnitTC
MaxValue | sint64 | 2147483647
MinValue | sint64 | 0
ModelCorrespondence | string | CIM_PrintSupply.MaxCapacityBasis
MaxCapacityBasis | uint16 |

Description

string

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

MappingStrings | string | MIB.IETF|Printer-MIB.prtMarkerSuppliesMaxCapacity, MIB.IETF|Finisher-MIB.finSuppyMaxCapacity
ModelCorrespondence | string | CIM_PrintSupply.MaxCapacity
ValueMap | string | 1, 2, 3, ..
Values | string | Other, Unknown, Actual, DMTF Reserved
OtherClassification | string |
Description | string | A free-form string that describes the PrintSupply classification when the value of the Classification property is equal to 1 (Other).
MaxLen | uint32 | 255
ModelCorrespondence | string | CIM_PrintSupply.Classification
OtherColorantName | string |

Description

string

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

MaxLen | uint32 | 255
ModelCorrespondence | string | CIM_PrintSupply.ColorantName
OtherColorantRole | string |
Description | string | If 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.
MaxLen | uint32 | 255
ModelCorrespondence | string | CIM_PrintSupply.ColorantRole
OtherSupplyUnit | string |
Description | string | A free-form string that describes the PrintSupply unit when the value of the SupplyUnit property is equal to 1 (Other).
MaxLen | uint32 | 255
ModelCorrespondence | string | CIM_PrintSupply.SupplyUnit
OtherTypeDescription | string |
Description | string | A free-form string that describes the PrintSupply type when the value of the Type property is equal to 1 (Other).
MaxLen | uint32 | 255
ModelCorrespondence | string | CIM_PrintSupply.Type
RemainingCapacity | uint32 |

Description

string

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

MappingStrings | string | MIB.IETF|Printer-MIB.prtMarkerSuppliesLevel, MIB.IETF|Finisher-MIB.finSuppyCurrentLevel, MIB.IETF|Printer-MIB.prtMarkerSuppliesSupplyUnit, MIB.IETF|Finisher-MIB.finSupplyUnit, MIB.IETF|Printer-MIB.PrtMarkerSuppliesSupplyUnitTC
MaxValue | sint64 | 2147483647
MinValue | sint64 | 0
ModelCorrespondence | string | CIM_PrintSupply.RemainingCapacityBasis
RemainingCapacityBasis | uint16 |

Description

string

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

MappingStrings | string | MIB.IETF|Printer-MIB.prtMarkerSuppliesLevel, MIB.IETF|Finisher-MIB.finSuppyCurrentLevel
ModelCorrespondence | string | CIM_PrintSupply.RemainingCapacity
ValueMap | string | 1, 2, 3, 4, ..
Values | string | Other, Unknown, Actual, AtLeastOne, DMTF Reserved
SupplyUnit | uint32 |
Description | string | Unit of measure for this PrintSupply container (for a supply that is consumed) or receptacle (for waste that is produced).
MappingStrings | string | MIB.IETF|Printer-MIB.prtMarkerSuppliesSupplyUnit, MIB.IETF|Finisher-MIB.finSupplyUnit, MIB.IETF|Printer-MIB.PrtMarkerSuppliesSupplyUnitTC
ModelCorrespondence | string | CIM_PrintSupply.OtherSupplyUnit
ValueMap | string | 1, 2, 3, 4, 7, 8, 11, 12, 13, 14, 15, 16, 17, 18, 19, ..
Values | string | Other, Unknown, TenThousandthsOfInches, Micrometers, Impressions, Sheets, Hours, ThousandthsOfOunces, TenthsOfGrams, HundrethsOfFluidOunces, TenthsOfMilliliters, Feet, Meters, Items, Percent, DMTF Reserved
Type | uint32 |
Description | string | The type of this PrintSupply.
MappingStrings | string | MIB.IETF|Printer-MIB.prtMarkerSuppliesType, MIB.IETF|Finisher-MIB.finSupplyType, MIB.IETF|IANA-PRINTER-MIB.PrtMarkerSuppliesTypeTC
ModelCorrespondence | string | CIM_PrintSupply.OtherTypeDescription
ValueMap | string | 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, ..

Values

string

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

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
Description | string | CIM_ManagedElement
DetailedStatus | uint16 | CIM_ManagedSystemElement
ElementName | string | CIM_ManagedElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_PrinterElement
Name | string | CIM_ManagedSystemElement
OperatingStatus | uint16 | CIM_ManagedSystemElement
PrimaryStatus | uint16 | CIM_ManagedSystemElement
SNMPRowId | uint32 | CIM_PrinterElement
Status | string | CIM_ManagedSystemElement
OperationalStatus | uint16[] | CIM_ManagedSystemElement
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods