Class CIM_Printer


  extends CIM_LogicalDevice
Capabilities and management of the Printer LogicalDevice. The ABNF for CIM references to PWG Standards and MIBs is in the directory 'ftp://ftp.pwg.org/pub/pwg/general/process' in the file 'pwg-cim-references-format-20060309.txt'. Examples include: (a) a MappingStrings reference to a PWG Standard is 'PWG5101-1.PWG|Section 4 Media Color Names'; (b) a MappingStrings reference to a PWG MIB is 'MIB.PWG|PWG-IMAGING-COUNTER-MIB.icMonitorCompletedJobs'. Note: A Printer shall be associated with at least one of every required component (e.g., PrintMarker) via an instance of the PrinterComponent class. A Printer may be associated with zero or more optional components (e.g., PrintSupply) via an instance of the ConcreteComponent class. See: Model in section 2 of Printer MIB (RFC 3805).
Details...
This class is not implemented.

Class Qualifiers

NameData TypeValueScopeFlavors
DescriptionstringCapabilities and management of the Printer LogicalDevice. The ABNF for CIM references to PWG Standards and MIBs is in the directory 'ftp://ftp.pwg.org/pub/pwg/general/process' in the file 'pwg-cim-references-format-20060309.txt'. Examples include: (a) a MappingStrings reference to a PWG Standard is 'PWG5101-1.PWG|Section 4 Media Color Names'; (b) a MappingStrings reference to a PWG MIB is 'MIB.PWG|PWG-IMAGING-COUNTER-MIB.icMonitorCompletedJobs'. Note: A Printer shall be associated with at least one of every required component (e.g., PrintMarker) via an instance of the PrinterComponent class. A Printer may be associated with zero or more optional components (e.g., PrintSupply) via an instance of the ConcreteComponent class. See: Model in section 2 of Printer MIB (RFC 3805).None TRANSLATABLE= true
MappingStringsstringMIB.IETF|Printer-MIB.prtGeneralEntryNone None
UMLPackagePathstringCIM::Device::PrintingNone None
Versionstring2.18.0TOSUBCLASS= falseTRANSLATABLE= true

Local Class Properties

NameData TypeQualifiers
NameData TypeValueScopeFlavors
AdditionalAvailabilityuint16
DescriptionstringAdditional availability and status of the Device in addition to that specified in the Availability property. The Availability property denotes the primary status and availability of the Device. In some cases, this property will not be sufficient to denote the complete status of the Device. In those cases, the AdditionalAvailability property can be used to provide further information. For example, the primary Availability of a device might be "Off line" (value=8) or in a low-power state (AdditionalAvailability value=14), or the Device could be running Diagnostics (AdditionalAvailability value=5, "In Test").None TRANSLATABLE= true
ModelCorrespondencestringCIM_LogicalDevice.AvailabilityNone None
ValueMapstring1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21None None
ValuesstringOther, Unknown, Running/Full Power, Warning, In Test, Not Applicable, Power Off, Off Line, Off Duty, Degraded, Not Installed, Install Error, Power Save - Unknown, Power Save - Low Power Mode, Power Save - Standby, Power Cycle, Power Save - Warning, Paused, Not Ready, Not Configured, QuiescedNone TRANSLATABLE= true
AllAlertsuint32
DescriptionstringA running counter of the total number of alerts (critical and non-critical) that have occurred on this Printer and have been recorded in corresponding instances of PrintAlertRecord. Note: This should be a persistent (lifetime) property.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
MappingStringsstringMIB.IETF|Printer-MIB.prtAlertAllEventsNone None
Availabilityuint16
DeprecatedstringCIM_AssociatedPowerManagementService.PowerState, CIM_ManagedSystemElement.OperationalStatus, CIM_EnabledLogicalElement.EnabledStateTOSUBCLASS= falseNone
DescriptionstringNote: The use of this property has been deprecated. Deprecated description: The primary availability and status of the Device. (Additional status information can be specified using the Additional Availability array property.) For example, the Availability property indicates that the Device is running and has full power (value=3), or is in a warning (4), test (5), degraded (10) or power save state (values 13-15 and 17). The Power Save states are defined as follows: Value 13 ("Power Save - Unknown") indicates that the Device is known to be in a power save mode, but its exact status in this mode is unknown; value 14 ("Power Save - Low Power Mode") indicates that the Device is in a power save state but still functioning, and might exhibit degraded performance; value 15 ("Power Save - Standby") indicates that the Device is not functioning but could be brought to full power 'quickly'; and value 17 ("Power Save - Warning") indicates that the Device is in a warning state, but is also in a power save mode.None TRANSLATABLE= true
MappingStringsstringMIF.DMTF|Operational State|006.5, MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus, MIF.DMTF|Host Device|001.5None None
ModelCorrespondencestringCIM_LogicalDevice.AdditionalAvailabilityNone None
ValueMapstring1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21None None
ValuesstringOther, Unknown, Running/Full Power, Warning, In Test, Not Applicable, Power Off, Off Line, Off Duty, Degraded, Not Installed, Install Error, Power Save - Unknown, Power Save - Low Power Mode, Power Save - Standby, Power Cycle, Power Save - Warning, Paused, Not Ready, Not Configured, QuiescedNone TRANSLATABLE= true
AvailableJobSheetsstring
DescriptionstringDescribes all of the job sheets that are available on the Printer. This method can also be used to describe the banner that a Printer might provide at the beginning of each Job or that can describe other user specified options.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|Printer-MIB.prtAuxiliarySheetStartupPage, MIB.IETF|Printer-MIB.prtAuxiliarySheetBannerPage, RFC2911.IETF|Printer.job-sheets-supported, RFC2911.IETF|Section 4.2 Job Template Attributes, RFC2911.IETF|Section 4.2.3 job-sheetsNone None
ModelCorrespondencestringCIM_PrintJob.RequiredJobSheetsNone None
AvailableRequestedStatesuint16
DescriptionstringAvailableRequestedStates indicates the possible values for the RequestedState parameter of the method RequestStateChange, used to initiate a state change. The values listed shall be a subset of the values contained in the RequestedStatesSupported property of the associated instance of CIM_EnabledLogicalElementCapabilities where the values selected are a function of the current state of the CIM_EnabledLogicalElement. This property may be non-null if an implementation is able to advertise the set of possible values as a function of the current state. This property shall be null if an implementation is unable to determine the set of possible values as a function of the current state.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
ModelCorrespondencestringCIM_EnabledLogicalElement.RequestStateChange, CIM_EnabledLogicalElementCapabilities.RequestedStatesSupportedNone None
ValueMapstring2, 3, 4, 6, 7, 8, 9, 10, 11None None
ValuesstringEnabled, Disabled, Shut Down, Offline, Test, Defer, Quiesce, Reboot, ResetNone TRANSLATABLE= true
Capabilitiesuint16
ArrayTypestringIndexedNone OVERRIDABLE= false
DeprecatedstringNo valueTOSUBCLASS= falseNone
DescriptionstringNote: The use of this property has been deprecated, due to ambiguity. Instead use the Printer component classes, e.g., PrintInputTray, PrintMarker, PrintFinisher, etc. For example, 3 (Duplex Printing) support can be found in the PrintMediaPath.Type property. Deprecated description: An array of integers that indicates Printer capabilities. Information such as "Duplex Printing" (value=3) or "Transparency Printing" (value=7) is specified in this property.None TRANSLATABLE= true
ModelCorrespondencestringCIM_Printer.CapabilityDescriptions, CIM_PrintJob.Finishing, CIM_PrintService.CapabilitiesNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21None None
ValuesstringUnknown, Other, Color Printing, Duplex Printing, Copies, Collation, Stapling, Transparency Printing, Punch, Cover, Bind, Black and White Printing, One Sided, Two Sided Long Edge, Two Sided Short Edge, Portrait, Landscape, Reverse Portrait, Reverse Landscape, Quality High, Quality Normal, Quality LowNone TRANSLATABLE= true
CapabilityDescriptionsstring
ArrayTypestringIndexedNone OVERRIDABLE= false
DeprecatedstringNo valueTOSUBCLASS= falseNone
DescriptionstringNote: The use of this property has been deprecated, due to ambiguity. Instead use the Printer component classes, e.g., PrintInputTray, PrintMarker, PrintFinisher, etc. Deprecated description: An array of free-form strings that provides more detailed explanations for any of the Printer features that are indicated in the Capabilities array. Note, each entry of this array is related to the entry in the Capabilities array that is located at the same index.None TRANSLATABLE= true
ModelCorrespondencestringCIM_Printer.CapabilitiesNone None
Captionstring
DescriptionstringThe Caption property is a short textual description (one- line string) of the object.None TRANSLATABLE= true
MaxLenuint3264None None
CharSetsSupportedstring
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringIdentifies the available character sets for the output of text that is related to managing the Printer. Strings provided in this property should conform to the semantics and syntax specified by section 4.1.2 ("Charset parameter") in RFC 2046 (MIME Part 2) and contained in the IANA character-set registry. Examples include "utf-8", "us-ascii" and "iso-8859-1".None TRANSLATABLE= true
MappingStringsstringMIB.IETF|Printer-MIB.prtLocalizationCharacterSet, MIB.IETF|IANA-CHARSET-MIB.IANACharset, RFC2911.IETF|Section 4.4.18 charset-supportedNone None
ModelCorrespondencestringCIM_PrintJob.CharSetNone None
CommunicationStatusuint16
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.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
ValueMapstring0, 1, 2, 3, 4, .., 0x8000..None None
ValuesstringUnknown, Not Available, Communication OK, Lost Communication, No Contact, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
ConsoleDisabledboolean
DescriptionstringDenotes whether or not the local console is disabled. If this value of this property is true, then input is not accepted from the local console. (i.e., console is locked).None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
MappingStringsstringMIB.IETF|Printer-MIB.prtConsoleDisableNone None
ConsoleDisplayBufferTextstring
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringA sequence of strings, each a line of human-readable text from the local console of the Printer, in the language specified by ConsoleNaturalLanguage.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
MappingStringsstringMIB.IETF|Printer-MIB.prtConsoleDisplayBufferTextNone None
ModelCorrespondencestringCIM_Printer.NaturalLanguagesSupported, CIM_Printer.ConsoleNaturalLanguageNone None
ConsoleNaturalLanguagestring
DescriptionstringIdentifies the current language that is being used by the Printer for the local console. The language listed in the ConsoleNaturalLanguage property should also be listed in NaturalLanguagesSupported. ConsoleDisplayBufferText values shall be in this natural language.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
MappingStringsstringMIB.IETF|Printer-MIB.prtConsoleLocalization, MIB.IETF|Printer-MIB.prtLocalizationLanguage, MIB.IETF|Printer-MIB.prtLocalizationCountryNone None
ModelCorrespondencestringCIM_Printer.NaturalLanguagesSupported, CIM_Printer.ConsoleDisplayBufferTextNone None
CreationClassNamestring
DescriptionstringCreationClassName 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.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
CriticalAlertsuint32
DescriptionstringA running counter of the number of critical alerts that have occurred on this Printer and have been recorded in corresponding instances of PrintAlertRecord. Note: This should be a persistent (lifetime) property.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
MappingStringsstringMIB.IETF|Printer-MIB.prtAlertCriticalEventsNone None
CurrentCapabilitiesuint16
DeprecatedstringNo valueTOSUBCLASS= falseNone
DescriptionstringNote: The use of this property has been deprecated, due to ambiguity. Instead use the Printer component classes, e.g., PrintInputTray, PrintMarker, PrintFinisher, etc. Deprecated description: Specifies which finishings and other capabilities of the Printer are currently being used. An entry in this property should also be listed in the Capabilities array.None TRANSLATABLE= true
ModelCorrespondencestringCIM_Printer.CapabilitiesNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21None None
ValuesstringUnknown, Other, Color Printing, Duplex Printing, Copies, Collation, Stapling, Transparency Printing, Punch, Cover, Bind, Black and White Printing, One Sided, Two Sided Long Edge, Two Sided Short Edge, Portrait, Landscape, Reverse Portrait, Reverse Landscape, Quality High, Quality Normal, Quality LowNone TRANSLATABLE= true
CurrentCharSetstring
DescriptionstringSpecifies the current character set that is being used for the output of text that relates to the management of the Printer. The character set that is described by this property should also be listed in CharsetsSupported. The string that is specified by this property should conform to the semantics and syntax that are specified by section 4.1.2 ("Charset parameter") in RFC 2046 (MIME Part 2) and contained in the IANA character-set registry. Examples include "utf-8", "us-ascii" and "iso-8859-1".None TRANSLATABLE= true
MappingStringsstringMIB.IETF|Printer-MIB.prtGeneralCurrentLocalization, MIB.IETF|Printer-MIB.prtLocalizationCharacterSet, MIB.IETF|IANA-CHARSET-MIB.IANACharset, RFC2911.IETF|Section 4.4.19 charset-configuredNone None
ModelCorrespondencestringCIM_Printer.CharSetsSupportedNone None
CurrentLanguageuint16
DeprecatedstringCIM_Printer.DefaultLanguageTOSUBCLASS= falseNone
DescriptionstringNote: The use of this property has been deprecated, due to ambiguity. Instead use DefaultLanguage. Deprecated description: Indicates the current printer language being used. A language that is being used by the Printer should also be listed in LanguagesSupported.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|Printer-MIB.prtChannelDefaultPageDescLangIndex, MIB.IETF|Printer-MIB.prtInterpreterLangFamily, MIB.IETF|IANA-PRINTER-MIB.PrtInterpreterLangFamilyTC, RFC2911.IETF|Section 4.4.21 document-format-defaultNone None
ModelCorrespondencestringCIM_Printer.LanguagesSupported, CIM_Printer.CurrentMimeTypeNone None
ValueMapstring1, 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, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67None None
ValuesstringOther, Unknown, PCL, HPGL, PJL, PS, PSPrinter, IPDS, PPDS, EscapeP, Epson, DDIF, Interpress, ISO6429, Line Data, MODCA, REGIS, SCS, SPDL, TEK4014, PDS, IGP, CodeV, DSCDSE, WPS, LN03, CCITT, QUIC, CPAP, DecPPL, Simple Text, NPAP, DOC, imPress, Pinwriter, NPDL, NEC201PL, Automatic, Pages, LIPS, TIFF, Diagnostic, CaPSL, EXCL, LCDS, XES, MIME, TIPSI, Prescribe, LinePrinter, IDP, XJCL, PDF, RPDL, IntermecIPL, UBIFingerprint, UBIDirectProtocol, Fujitsu, PCLXL, ART, CGM, JPEG, CALS1, CALS2, NIRS, C4None TRANSLATABLE= true
CurrentMimeTypestring
DeprecatedstringCIM_Printer.DefaultMimeTypeTOSUBCLASS= falseNone
DescriptionstringNote: The use of this property has been deprecated, due to ambiguity. Instead use DefaultMimeType. Deprecated description: Specifies the MIME type that is currently in use by the Printer if the CurrentLanguage is set to indicate that a MIME type is in use (value=47).None TRANSLATABLE= true
MappingStringsstringRFC2911.IETF|Section 4.4.21 document-format-defaultNone None
ModelCorrespondencestringCIM_Printer.CurrentLanguageNone None
CurrentNaturalLanguagestring
DescriptionstringIdentifies the current language that is being used by the Printer for management. The language listed in the CurrentNaturalLanguage property should also be listed in NaturalLanguagesSupported.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|Printer-MIB.prtGeneralCurrentLocalization, MIB.IETF|Printer-MIB.prtLocalizationLanguage, MIB.IETF|Printer-MIB.prtLocalizationCountry, RFC2911.IETF|Section 4.4.19 natural-language-configuredNone None
ModelCorrespondencestringCIM_Printer.NaturalLanguagesSupportedNone None
CurrentOperatorstring
DescriptionstringThe name of the person who is responsible for operating this Printer. It is suggested that this string include information that would enable other humans to reach the operator, such as a phone number. As a convention to facilitate automatic notification of the operator by the agent or network management station, the phone number, fax number or email address should be indicated by the URL schemes 'tel:', 'fax:' and 'mailto:', respectively. If either the phone, fax, or email information is not available, then a line should not be included for this information. NOTE: For interoperability purposes, it is advisable to use email addresses formatted according to [RFC2822] requirements.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
MappingStringsstringMIB.IETF|Printer-MIB.prtGeneralCurrentOperatorNone None
MaxLenuint32255None None
MinLenuint320None None
CurrentPaperTypestring
DeprecatedstringCIM_Printer.DefaultPaperTypeTOSUBCLASS= falseNone
DescriptionstringNote: The use of this property has been deprecated, due to ambiguity. Instead use DefaultPaperType. Deprecated description: Specifies the paper type that the Printer is currently using. The string should be a value of PaperTypesSupported. The values of the property SHOULD conform to the requirements of the PWG Media Standardized Names specification [PWG5101.1], which defines the normative values for this property. See older Appendix B 'Media Size Names' and Appendix C 'Media Names' of IETF Printer MIB v2 [RFC3805] which list the values of standardized media names defined in ISO DPA [ISO10175].None TRANSLATABLE= true
MappingStringsstringPWG5101-1.PWG|Media Standardized Names, MIB.IETF|Printer-MIB.prtInputDefaultIndex, MIB.IETF|Printer-MIB.prtInputMediaName, RFC2911.IETF|Printer.media-default, RFC2911.IETF|Section 4.2 Job Template Attributes, RFC2911.IETF|Section 4.2.11 media, RFC2911.IETF|APPENDIX C 'media' keyword valuesNone None
ModelCorrespondencestringCIM_Printer.PaperTypesAvailableNone None
DefaultCapabilitiesuint16
DeprecatedstringNo valueTOSUBCLASS= falseNone
DescriptionstringNote: The use of this property has been deprecated, due to ambiguity. Instead use the Printer component classes, e.g., PrintInputTray, PrintMarker, PrintFinisher, etc. Deprecated description: Specifies which finishings and other capabilities of the Printer will be used by default. An entry in Default Capabilities should also be listed in the Capabilities array.None TRANSLATABLE= true
ModelCorrespondencestringCIM_Printer.CapabilitiesNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21None None
ValuesstringUnknown, Other, Color Printing, Duplex Printing, Copies, Collation, Stapling, Transparency Printing, Punch, Cover, Bind, Black and White Printing, One Sided, Two Sided Long Edge, Two Sided Short Edge, Portrait, Landscape, Reverse Portrait, Reverse Landscape, Quality High, Quality Normal, Quality LowNone TRANSLATABLE= true
DefaultCopiesuint32
DescriptionstringNote: The use of this property will be deprecated after copying DefaultCopies to PrintService[Settings]. The number of copies that will be produced for a single Job unless otherwise specified.None TRANSLATABLE= true
MappingStringsstringRFC2911.IETF|Printer.copies-default, RFC2911.IETF|Section 4.2 Job Template Attributes, RFC2911.IETF|Section 4.2.5 copiesNone None
DefaultLanguageuint16
DescriptionstringIndicates the default printer language. A language that is used as a default by the Printer should also be listed in LanguagesSupported.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|Printer-MIB.prtChannelDefaultPageDescLangIndex, MIB.IETF|Printer-MIB.prtInterpreterLangFamily, MIB.IETF|IANA-PRINTER-MIB.PrtInterpreterLangFamilyTC, RFC2911.IETF|Section 4.4.21 document-format-defaultNone None
ModelCorrespondencestringCIM_Printer.LanguagesSupported, CIM_Printer.DefaultMimeTypeNone None
ValueMapstring1, 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, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67None None
ValuesstringOther, Unknown, PCL, HPGL, PJL, PS, PSPrinter, IPDS, PPDS, EscapeP, Epson, DDIF, Interpress, ISO6429, Line Data, MODCA, REGIS, SCS, SPDL, TEK4014, PDS, IGP, CodeV, DSCDSE, WPS, LN03, CCITT, QUIC, CPAP, DecPPL, Simple Text, NPAP, DOC, imPress, Pinwriter, NPDL, NEC201PL, Automatic, Pages, LIPS, TIFF, Diagnostic, CaPSL, EXCL, LCDS, XES, MIME, TIPSI, Prescribe, LinePrinter, IDP, XJCL, PDF, RPDL, IntermecIPL, UBIFingerprint, UBIDirectProtocol, Fujitsu, PCLXL, ART, CGM, JPEG, CALS1, CALS2, NIRS, C4None TRANSLATABLE= true
DefaultMimeTypestring
DescriptionstringSpecifies the default MIME type that is used by the Printer if the DefaultLanguage is set to indicate that a MIME type is in use (value=47).None TRANSLATABLE= true
MappingStringsstringRFC2911.IETF|Section 4.4.21 document-format-defaultNone None
ModelCorrespondencestringCIM_Printer.DefaultLanguageNone None
DefaultNumberUpuint32
DescriptionstringNote: The use of this property will be deprecated after copying DefaultNumberUp to PrintService[Settings]. The number of print-stream pages that the Printer will render onto a single media sheet unless a Job specifies otherwise.None TRANSLATABLE= true
MappingStringsstringRFC2911.IETF|Printer.number-up-default, RFC2911.IETF|Section 4.2 Job Template Attributes, RFC2911.IETF|Section 4.2.9 number-upNone None
DefaultPaperTypestring
DescriptionstringSpecifies the paper type that the Printer will use if a PrintJob does not specify a particular type. The string should be a value of PaperTypesSupported. The values of the property SHOULD conform to the requirements of the PWG Media Standardized Names specification [PWG5101.1], which defines the normative values for this property. See older Appendix B 'Media Size Names' and Appendix C 'Media Names' of IETF Printer MIB v2 [RFC3805] which list the values of standardized media names defined in ISO DPA [ISO10175].None TRANSLATABLE= true
MappingStringsstringPWG5101-1.PWG|Media Standardized Names, MIB.IETF|Printer-MIB.prtInputDefaultIndex, MIB.IETF|Printer-MIB.prtInputMediaName, RFC2911.IETF|Printer.media-default, RFC2911.IETF|Section 4.2 Job Template Attributes, RFC2911.IETF|Section 4.2.11 media, RFC2911.IETF|APPENDIX C 'media' keyword valuesNone None
ModelCorrespondencestringCIM_Printer.PaperTypesAvailableNone None
Descriptionstring
DescriptionstringThe Description property provides a textual description of the object.None TRANSLATABLE= true
DetailedStatusuint16
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.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
ModelCorrespondencestringCIM_EnabledLogicalElement.PrimaryStatus, CIM_ManagedSystemElement.HealthStateNone None
ValueMapstring0, 1, 2, 3, 4, 5, .., 0x8000..None None
ValuesstringNot Available, No Additional Information, Stressed, Predictive Failure, Non-Recoverable Error, Supporting Entity in Error, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
DetectedErrorStateuint16
DescriptionstringPrinter error info mapped from hrPrinterDetectedErrorState in Host Resources MIB (RFC 2790), as follows: 0 (Unknown) means no error information is available 1 (Other) means some non-standard error has occurred - see Printer.ErrorInformation for more information 2 (No Error) means there are no error conditions 3 (Low Paper) means PrintInputTray is low on paper 4 (No Paper) means all PrintInputTray(s) are empty 5 (Low Toner) means PrintMarker is low on toner 6 (No Toner) means PrintMarker is out of toner 7 (Door Open) means PrintInterlock is open 8 (Jammed) means PrintMarker or PrintMediaPath is jammed 9 (Offline) means Printer is offline (see PrinterStatus) 10 (Service Requested) means intervention is required 11 (Output Bin Full) means PrintOutputTray is full 12 (Input Tray Missing) means PrintInputTray is missing 13 (Output Tray Missing) means PrintOutputTray is missing 14 (Marker Supply Missing) means PrintSupply is missing 15 (Output Near Full) means PrintOutputTray is nearly full 16 (Input Tray Empty) means PrintInputTray is empty 17 (Overdue Prevent Maint) means Printer needs service.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|HOST-RESOURCES-MIB.hrPrinterDetectedErrorStateNone None
ModelCorrespondencestringCIM_Printer.ErrorInformationNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, ..None None
ValuesstringUnknown, Other, No Error, Low Paper, No Paper, Low Toner, No Toner, Door Open, Jammed, Offline, Service Requested, Output Bin Full, Input Tray Missing, Output Tray Missing, Marker Supply Missing, Output Near Full, Input Tray Empty, Overdue Prevent Maint, DMTF ReservedNone TRANSLATABLE= true
DeviceIDstring
DescriptionstringAn address or other identifying information used to uniquely name the LogicalDevice.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint3264None None
ElementNamestring
DescriptionstringThe user-friendly name for this instance of Printer. In addition, the user-friendly name can be used as an index property for a search or query. (Note: The name does not have to be unique within a namespace.) This name shall be generated as a factory default by the manufacturer and may be changed out-of-band to a site-specific name by the system administrator.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|Printer-MIB.prtGeneralPrinterNameNone None
ModelCorrespondencestringCIM_ManagedElement.ElementNameNone None
OverridestringElementNameTOSUBCLASS= falseNone
RequiredbooleantrueNone OVERRIDABLE= false
EnabledDefaultuint16
DescriptionstringAn enumerated value indicating an administrator's default or startup configuration for the Enabled State of an element. By default, the element is "Enabled" (value=2).None TRANSLATABLE= true
ValueMapstring2, 3, 5, 6, 7, 9, .., 32768..65535None None
ValuesstringEnabled, Disabled, Not Applicable, Enabled but Offline, No Default, Quiesce, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
WritebooleantrueNone None
EnabledStateuint16
DescriptionstringEnabledState is an integer enumeration that indicates the enabled and disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value=4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled and disabled states: Enabled (2) indicates that the element is or could be executing commands, will process any queued commands, and queues new requests. Disabled (3) indicates that the element will not execute commands and will drop any new requests. Shutting Down (4) indicates that the element is in the process of going to a Disabled state. Not Applicable (5) indicates the element does not support being enabled or disabled. Enabled but Offline (6) indicates that the element might be completing commands, and will drop any new requests. Test (7) indicates that the element is in a test state. Deferred (8) indicates that the element might be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued.None TRANSLATABLE= true
ModelCorrespondencestringCIM_EnabledLogicalElement.OtherEnabledStateNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11..32767, 32768..65535None None
ValuesstringUnknown, Other, Enabled, Disabled, Shutting Down, Not Applicable, Enabled but Offline, In Test, Deferred, Quiesce, Starting, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
ErrorClearedboolean
DeprecatedstringCIM_ManagedSystemElement.OperationalStatusTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method is deprecated. Deprecated description: ErrorCleared is a Boolean property that indicates that the error reported in LastErrorCode is now cleared.None TRANSLATABLE= true
ErrorDescriptionstring
DeprecatedstringCIM_DeviceErrorData.ErrorDescriptionTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method is deprecated. Deprecated description: ErrorDescription is a free-form string that supplies more information about the error recorded in LastErrorCode and information on any corrective actions that can be taken.None TRANSLATABLE= true
ErrorInformationstring
DescriptionstringAn array that provides supplemental information for the current error state, that is indicated in DetectedErrorState.None TRANSLATABLE= true
MappingStringsstringRFC2911.IETF|Section 4.4.13 printer-state-messageNone None
ModelCorrespondencestringCIM_Printer.DetectedErrorStateNone None
Generationuint64
DescriptionstringGeneration is an optional, monotonically increasing property that may be used to identify a particular generation of the resource represented by this class. If Generation is supported by the implementation, its value shall not be null. Except as otherwise specified, a value (including null) of Generation specified at creation time shall be replaced by null if Generation is not supported by the implementation or shall be a, (possibly different), non-null value if the implementation does support Generation. After creation and if supported, Generation shall be updated, at least once per access, whenever the represented resource is modified, regardless of the source of the modification. Note: the Generation value only needs to be updated once between references, even if the resource is updated many times. The key point is to assure that it will be different if there have been updates, not to count each update. Note: unless otherwise specified, the value of Generation within one instance is not required to be coordinated with the value of Generation in any other instance. Note:the semantics of the instance, (as defined by its creation class), define the underlying resource. That underlying resource may be a collection or aggregation of resources. And, in that case, the semantics of the instance further define when updates to constituent resources also require updates to the Generation of the collective resource. Default behavior of composite aggregations should be to update the Generation of the composite whenever the Generation of a component is updated. Subclasses may define additional requirements for updates on some or all of related instances. For a particular instance, the value of Generation may wrap through zero, but the elapsed time between wraps shall be greater than 10's of years. This class does not require Generation to be unique across instances of other classes nor across instances of the same class that have different keys. Generation shall be different across power cycles, resets, or reboots if any of those actions results in an update. Generation may be different across power cycles, resets, or reboots if those actions do not result in an update. If the Generation property of an instance is non-null, and if any attempt to update the instance includes the Generation property, then if it doesn't match the current value, the update shall fail. The usage of this property is intended to be further specified by applicable management profiles. Typically, a client will read the value of this property and then supply that value as input to an operation that modifies the instance in some means. This may be via an explicit parameter in an extrinsic method or via an embedded value in an extrinsic method or intrinsic operation. For example: a profile may require that an intrinsic instance modification supply the Generation property and that it must match for the modification to succeed.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
HealthStateuint16
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.None TRANSLATABLE= true
ValueMapstring0, 5, 10, 15, 20, 25, 30, ..None None
ValuesstringUnknown, OK, Degraded/Warning, Minor failure, Major failure, Critical failure, Non-recoverable error, DMTF ReservedNone TRANSLATABLE= true
HorizontalResolutionuint32
DeprecatedstringCIM_PrintMarker.XFeedAddressabilityTOSUBCLASS= falseNone
DescriptionstringNote: The use of this property has been deprecated, due to ambiguity. Instead use the XFeedAddressability property in the Printer component classes PrintMarker and PrintInterpreter. Deprecated description: The resolution of the Printer in Pixels per Inch in the cross-feed direction, i.e., short-edge in portrait feed mode.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|Printer-MIB.prtMarkerAddressabilityXFeedDir, RFC2911.IETF|Section 4.2.12 printer-resolutionNone None
ModelCorrespondencestringCIM_PrintJob.HorizontalResolutionNone None
PUnitstringpixel / inchNone None
UnitsstringPixels per InchNone TRANSLATABLE= true
IdentifyingDescriptionsstring
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringAn array of free-form strings providing explanations and details behind the entries in the OtherIdentifyingInfo array. Note that each entry of this array is related to the entry in OtherIdentifyingInfo that is located at the same index.None TRANSLATABLE= true
ModelCorrespondencestringCIM_LogicalDevice.OtherIdentifyingInfoNone None
InstallDatedatetime
DescriptionstringA datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed.None TRANSLATABLE= true
MappingStringsstringMIF.DMTF|ComponentID|001.5None None
InstanceIDstring
DescriptionstringInstanceID is an optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace. Various subclasses of this class may override this property to make it required, or a key. Such subclasses may also modify the preferred algorithms for ensuring uniqueness that are defined below. 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> must 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> must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must 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 not null and the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. If not set to null for DMTF-defined instances, the "preferred" algorithm must be used with the <OrgID> set to CIM.None TRANSLATABLE= true
JobCountSinceLastResetuint32
CounterbooleantrueNone None
DescriptionstringPrinter jobs that are processed since last reset. These jobs can be processed from one or more PrintQueues.None TRANSLATABLE= true
MappingStringsstringMIB.PWG|PWG-IMAGING-COUNTER-MIB.icMonitorCompletedJobsNone None
LanguagesSupporteduint16
DescriptionstringAn array that indicates the print languages that are natively supported.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|Printer-MIB.prtInterpreterLangFamily, MIB.IETF|IANA-PRINTER-MIB.PrtInterpreterLangFamilyTC, RFC2911.IETF|Section 4.4.22 document-format-supportedNone None
ModelCorrespondencestringCIM_Printer.MimeTypesSupported, CIM_PrintJob.Language, CIM_PrintService.LanguagesSupportedNone None
ValueMapstring1, 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, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67None None
ValuesstringOther, Unknown, PCL, HPGL, PJL, PS, PSPrinter, IPDS, PPDS, EscapeP, Epson, DDIF, Interpress, ISO6429, Line Data, MODCA, REGIS, SCS, SPDL, TEK4014, PDS, IGP, CodeV, DSCDSE, WPS, LN03, CCITT, QUIC, CPAP, DecPPL, Simple Text, NPAP, DOC, imPress, Pinwriter, NPDL, NEC201PL, Automatic, Pages, LIPS, TIFF, Diagnostic, CaPSL, EXCL, LCDS, XES, MIME, TIPSI, Prescribe, LinePrinter, IDP, XJCL, PDF, RPDL, IntermecIPL, UBIFingerprint, UBIDirectProtocol, Fujitsu, PCLXL, ART, CGM, JPEG, CALS1, CALS2, NIRS, C4None TRANSLATABLE= true
LastErrorCodeuint32
DeprecatedstringCIM_DeviceErrorData.LastErrorCodeTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method is deprecated. Deprecated description: LastErrorCode captures the last error code reported by the LogicalDevice.None TRANSLATABLE= true
LocationIndicatoruint16
DescriptionstringAn integer that reflects the state of an indicator (e.g., LED) that is part of a device. Reading the value gives the current state. Writing the value with 'On'/'Off' turns the indicator on/off, other values may not be written.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
ModelCorrespondencestringCIM_AlarmDevice.AlarmState, CIM_AlarmDevice.AudioIndicatorIsDisabled, CIM_AlarmDevice.VisualIndicatorIsDisabled, CIM_AlarmDevice.MotionIndicatorIsDisabledNone None
ValueMapstring0, 2, 3, 4None None
ValuesstringUnknown, On, Off, Not SupportedNone TRANSLATABLE= true
WritebooleantrueNone None
MarkingTechnologyuint16
DeprecatedstringCIM_PrintMarker.MarkTechTOSUBCLASS= falseNone
DescriptionstringNote: The use of this property has been deprecated, due to ambiguity. Instead use PrintMarker.MarkTech. Deprecated description: Specifies the marking technology that is used by the Printer.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|Printer-MIB.prtMarkerMarkTech, MIB.IETF|IANA-PRINTER-MIB.PrtMarkerMarkTechTCNone None
ValueMapstring1, 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, 27None None
ValuesstringOther, Unknown, Electrophotographic LED, Electrophotographic Laser, Electrophotographic Other, Impact Moving Head Dot Matrix 9pin, Impact Moving Head Dot Matrix 24pin, Impact Moving Head Dot Matrix Other, Impact Moving Head Fully Formed, Impact Band, Impact Other, Inkjet Aqueous, Inkjet Solid, Inkjet Other, Pen, Thermal Transfer, Thermal Sensitive, Thermal Diffusion, Thermal Other, Electroerosion, Electrostatic, Photographic Microfiche, Photographic Imagesetter, Photographic Other, Ion Deposition, eBeam, TypesetterNone TRANSLATABLE= true
MaxCopiesuint32
DescriptionstringNote: The use of this property will be deprecated after copying MaxCopies to PrintService[Capabilities]. The maximum number of copies that can be produced by the Printer from a single Job.None TRANSLATABLE= true
MappingStringsstringRFC2911.IETF|Printer.copies-supported, RFC2911.IETF|Section 4.2 Job Template Attributes, RFC2911.IETF|Section 4.2.5 copiesNone None
ModelCorrespondencestringCIM_PrintJob.CopiesNone None
MaxNumberUpuint32
DescriptionstringNote: The use of this property will be deprecated after copying MaxNumberUp to PrintService[Capabilities]. The maximum number of print-stream pages that the Printer can render onto a single media sheet.None TRANSLATABLE= true
MappingStringsstringRFC2911.IETF|Printer.number-up-supported, RFC2911.IETF|Section 4.2 Job Template Attributes, RFC2911.IETF|Section 4.2.9 number-upNone None
ModelCorrespondencestringCIM_PrintJob.NumberUpNone None
MaxQuiesceTimeuint64
DeprecatedstringNo valueTOSUBCLASS= falseNone
DescriptionstringNote: The use of this property has been deprecated. When evaluating the use of Quiesce, it was determined that this single property is not adequate for describing when a device will automatically exit a quiescent state. In fact, the most likely scenario for a device to exit a quiescent state was determined to be based on the number of outstanding requests queued rather than on a maximum time. This decision will be re-evaluated and repositioned later. Deprecated description: Maximum time, in milliseconds, that a Device can run in a "Quiesced" state. The state is defined in its Availability and AdditionalAvailability properties, where "Quiesced" is conveyed by the value 21. What occurs at the end of the time limit is device-specific. The Device can unquiesce, can be offline, or can take other actions. A value of 0 indicates that a Device can remain quiesced indefinitely.None TRANSLATABLE= true
PUnitstringsecond * 10^-3None None
UnitsstringMilliSecondsNone TRANSLATABLE= true
MaxSizeSupporteduint32
DescriptionstringNote: The use of this property will be deprecated after copying MaxSizeSupported to PrintService[Capabilities]. Specifies the largest Job (as a byte stream) that the Printer will accept in units of Kbytes. A value of 0 indicates that no limit has been set.None TRANSLATABLE= true
MappingStringsstringRFC2911.IETF|Section 4.4.33 job-k-octets-supportedNone None
ModelCorrespondencestringCIM_PrintJob.JobSizeNone None
PUnitstringbyte * 10^3None None
UnitsstringKiloBytesNone TRANSLATABLE= true
MimeTypesSupportedstring
DescriptionstringAn array of free-form strings that provides more detailed explanations of any MIME types that are supported by the Printer. If data is provided for this property, then the (value=47), "Mime", should be included in the Languages Supported property.None TRANSLATABLE= true
MappingStringsstringRFC2911.IETF|Section 4.4.22 document-format-supportedNone None
ModelCorrespondencestringCIM_Printer.LanguagesSupported, CIM_PrintJob.MimeTypes, CIM_PrintService.MimeTypesSupportedNone None
Namestring
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.None TRANSLATABLE= true
MaxLenuint321024None None
NaturalLanguagesSupportedstring
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringIdentifies the available languages for strings that are used by the Printer for the output of management information. The strings should conform to RFC 1766, for example, "en" is used for English.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|Printer-MIB.prtLocalizationLanguage, MIB.IETF|Printer-MIB.prtLocalizationCountry, RFC2911.IETF|Printer.generated-natural-language-supported, RFC2911.IETF|Section 4.4.20None None
ModelCorrespondencestringCIM_Printer.CurrentNaturalLanguage, CIM_Printer.ConsoleNaturalLanguage, CIM_PrintJob.NaturalLanguageNone None
OperatingStatusuint16
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.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledStateNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, .., 0x8000..None None
ValuesstringUnknown, Not Available, Servicing, Starting, Stopping, Stopped, Aborted, Dormant, Completed, Migrating, Emigrating, Immigrating, Snapshotting, Shutting Down, In Test, Transitioning, In Service, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
OperationalStatusuint16
ArrayTypestringIndexedNone OVERRIDABLE= false
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.None TRANSLATABLE= true
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptionsNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, .., 0x8000..None None
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 ReservedNone TRANSLATABLE= true
OtherEnabledStatestring
DescriptionstringA string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ("Other"). This property must be set to null when EnabledState is any value other than 1.None TRANSLATABLE= true
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledStateNone None
OtherIdentifyingInfostring
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringOtherIdentifyingInfo captures data, in addition to DeviceID information, that could be used to identify a LogicalDevice. For example, you could use this property to hold the operating system's user-friendly name for the Device.None TRANSLATABLE= true
MaxLenuint32256None None
ModelCorrespondencestringCIM_LogicalDevice.IdentifyingDescriptionsNone None
PaperSizesSupporteduint16
DeprecatedstringCIM_Printer.PaperTypesSupportedTOSUBCLASS= falseNone
DescriptionstringNote: The use of this property has been deprecated, due to ambiguity. Instead use PaperTypesSupported. Deprecated description: An integer array that indicates the types of paper supported.None TRANSLATABLE= true
MappingStringsstringPWG5101-1.PWG|Media Standardized Names, MIB.IETF|Printer-MIB.prtInputMediaName, MIB.IETF|Printer-MIB.prtInputMediaDimFeedDirChosen, MIB.IETF|Printer-MIB.prtInputMediaDimXFeedDirChosen, RFC2911.IETF|Printer.media-supported, RFC2911.IETF|Section 4.2 Job Template Attributes, RFC2911.IETF|Section 4.2.11 media, RFC2911.IETF|APPENDIX C 'media' keyword valuesNone None
ValueMapstring0, 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, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75None None
ValuesstringUnknown, Other, A, B, C, D, E, Letter, Legal, NA-10x13-Envelope, NA-9x12-Envelope, NA-Number-10-Envelope, NA-7x9-Envelope, NA-9x11-Envelope, NA-10x14-Envelope, NA-Number-9-Envelope, NA-6x9-Envelope, NA-10x15-Envelope, A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, B0, B1, B2, B3, B4, B5, B6, B7, B8, B9, B10, C0, C1, C2, C3, C4, C5, C6, C7, C8, ISO-Designated, JIS B0, JIS B1, JIS B2, JIS B3, JIS B4, JIS B5, JIS B6, JIS B7, JIS B8, JIS B9, JIS B10, NA-Letter, NA-Legal, B4-Envelope, B5-Envelope, C3-Envelope, C4-Envelope, C5-Envelope, C6-Envelope, Designated-Long-Envelope, Monarch-Envelope, Executive, Folio, Invoice, Ledger, QuartoNone TRANSLATABLE= true
PaperTypesAvailablestring
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringAn array of free-form strings specifying the types and sizes of paper that are currently available on the Printer. The values of the property SHOULD conform to the requirements of the PWG Media Standardized Names specification [PWG5101.1], which defines the normative values for this property. See older Appendix B 'Media Size Names' and Appendix C 'Media Names' of IETF Printer MIB v2 [RFC3805] which list the values of standardized media names defined in ISO DPA [ISO10175].None TRANSLATABLE= true
MappingStringsstringPWG5101-1.PWG|Media Standardized Names, MIB.IETF|Printer-MIB.prtInputMediaName, RFC2911.IETF|Printer.media-ready, RFC2911.IETF|Section 4.2 Job Template Attributes, RFC2911.IETF|Section 4.2.11 media, RFC2911.IETF|APPENDIX C 'media' keyword valuesNone None
ModelCorrespondencestringCIM_PrintJob.RequiredPaperType, CIM_PrintService.PaperTypesAvailableNone None
PowerManagementCapabilitiesuint16
DeprecatedstringCIM_PowerManagementCapabilities.PowerCapabilitiesTOSUBCLASS= falseNone
DescriptionstringNote: The use of this property has been deprecated. Instead, use the PowerCapabilites property in an associated PowerManagementCapabilities class. Deprecated description: An enumerated array describing the power management capabilities of the Device.None TRANSLATABLE= true
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7None None
ValuesstringUnknown, Not Supported, Disabled, Enabled, Power Saving Modes Entered Automatically, Power State Settable, Power Cycling Supported, Timed Power On SupportedNone TRANSLATABLE= true
PowerManagementSupportedboolean
DeprecatedstringCIM_PowerManagementCapabilitiesTOSUBCLASS= falseNone
DescriptionstringNote: The use of this property has been deprecated. Instead, the existence of an associated PowerManagementCapabilities class (associated using the ElementCapabilities relationship) indicates that power management is supported. Deprecated description: Boolean that indicates that the Device can use power management.None TRANSLATABLE= true
PowerOnHoursuint64
CounterbooleantrueNone None
DeprecatedstringCIM_PoweredStatisticalData.PowerOnHoursTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method is deprecated. Deprecated description: The number of consecutive hours that this Device has been powered on since its last power cycle.None TRANSLATABLE= true
PUnitstringhourNone None
UnitsstringHoursNone TRANSLATABLE= true
PrimaryStatusuint16
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.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
ModelCorrespondencestringCIM_ManagedSystemElement.DetailedStatus, CIM_ManagedSystemElement.HealthStateNone None
ValueMapstring0, 1, 2, 3, .., 0x8000..None None
ValuesstringUnknown, OK, Degraded, Error, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
PrinterStatusuint16
DescriptionstringStatus information for a Printer, beyond that specified in the LogicalDevice.Availability property. Values mapped directly from hrPrinterStatus in Host Resources MIB (RFC 2790) are: 1 (Other) means the printer is in some non-standard state - see Printer.ErrorInformation for more information 2 (Unknown) means the printer state is unknown 3 (Idle) means the printer is ready but idle 4 (Printing) means the printer is processing job(s) 5 (Warmup) means the printer is warming up - not ready Note: The values 6 (Stopped Printing) and 7 (Offline) are redundant with DetectedErrorState (below) and not mapped from hrPrinterStatus in Host Resources MIB (RFC 2790).None TRANSLATABLE= true
MappingStringsstringMIB.IETF|HOST-RESOURCES-MIB.hrPrinterStatus, MIB.IETF|HOST-RESOURCES-MIB.hrPrinterDetectedErrorStateNone None
ModelCorrespondencestringCIM_LogicalDevice.Availability, CIM_Printer.DetectedErrorState, CIM_Printer.ErrorInformationNone None
ValueMapstring1, 2, 3, 4, 5, 6, 7, ..None None
ValuesstringOther, Unknown, Idle, Printing, Warmup, Stopped Printing, Offline, DMTF ReservedNone TRANSLATABLE= true
RequestedStateuint16
DescriptionstringRequestedState is an integer enumeration that indicates the last requested or desired state for the element, irrespective of the mechanism through which it was requested. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration. "Unknown" (0) indicates the last requested state for the element is unknown. Note that the value "No Change" (5) has been deprecated in lieu of indicating the last requested state is "Unknown" (0). If the last requested or desired state is unknown, RequestedState should have the value "Unknown" (0), but may have the value "No Change" (5).Offline (6) indicates that the element has been requested to transition to the Enabled but Offline EnabledState. It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are "Reboot" (10) and "Reset" (11). Reboot refers to doing a "Shut Down" and then moving to an "Enabled" state. Reset indicates that the element is first "Disabled" and then "Enabled". The distinction between requesting "Shut Down" and "Disabled" should also be noted. Shut Down requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state. The Disabled state requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, because it allows an explicit invocation of the operation and the return of a result code. If knowledge of the last RequestedState is not supported for the EnabledLogicalElement, the property shall be NULL or have the value 12 "Not Applicable".None TRANSLATABLE= true
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledStateNone None
ValueMapstring0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, .., 32768..65535None None
ValuesstringUnknown, Enabled, Disabled, Shut Down, No Change, Offline, Test, Deferred, Quiesce, Reboot, Reset, Not Applicable, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
SerialNumberstring
DescriptionstringA serial number for this Printer (that may index adevice catalog or inventory). The original value is a factory default set by the device manufacturer and may be changed out-of-band to a site-specific name by the system administrator.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
MappingStringsstringMIB.IETF|Printer-MIB.prtGeneralSerialNumberNone None
MaxLenuint32255None None
MinLenuint320None None
ServicePersonstring
DescriptionstringThe name of the person responsible for servicing this Printer. It is suggested that this string include information that would enable other humans to reach the service person, such as a phone number. As a convention to facilitate automatic notification of the operator by the agent or network management station, the phone number, fax number or email address should be indicated by the URL schemes 'tel:', 'fax:' and 'mailto:', respectively. If either the phone, fax, or email information is not available, then a line should not be included for this information. NOTE: For interoperability purposes, it is advisable to use email addresses formatted per [RFC2822] requirements.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
MappingStringsstringMIB.IETF|Printer-MIB.prtGeneralServicePersonNone None
MaxLenuint32255None None
MinLenuint320None None
Statusstring
DeprecatedstringCIM_ManagedSystemElement.OperationalStatusTOSUBCLASS= falseNone
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.None TRANSLATABLE= true
MaxLenuint3210None None
ValueMapstringOK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed, NonRecover, No Contact, Lost Comm, StoppedNone None
StatusDescriptionsstring
ArrayTypestringIndexedNone OVERRIDABLE= false
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.None TRANSLATABLE= true
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatusNone None
StatusInfouint16
DeprecatedstringCIM_EnabledLogicalElement.EnabledStateTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method is deprecated in lieu of a more clearly named property (EnabledState) that is inherited from ManagedSystemElement and that has additional enumerated values. Deprecated description: The StatusInfo property indicates whether the Logical Device is in an enabled state (value=3), disabled state (value=4), some other state (value=1), or an unknown state (value=2). If this property does not apply to the LogicalDevice, the value 5 ("Not Applicable") should be used. If a Device is ("Enabled")(value=3), it has been powered up and is configured and operational. The Device might or might not be functionally active, depending on whether its Availability (or AdditionalAvailability) indicates that it is ("Running/Full Power")(value=3) or ("Off line") (value=8). In an enabled but offline mode, a Device might be performing out-of-band requests, such as running Diagnostics. If StatusInfo is ("Disabled") (value=4), a Device can only be "enabled" or powered off. In a personal computer environment, ("Disabled") means that the driver of the device is not available in the stack. In other environments, a Device can be disabled by removing its configuration file. A disabled device is physically present in a System and consuming resources, but it cannot be communicated with until a driver is loaded, a configuration file is loaded, or some other "enabling" activity has occurred.None TRANSLATABLE= true
MappingStringsstringMIF.DMTF|Operational State|006.4None None
ValueMapstring1, 2, 3, 4, 5None None
ValuesstringOther, Unknown, Enabled, Disabled, Not ApplicableNone TRANSLATABLE= true
SystemCreationClassNamestring
DescriptionstringThe CreationClassName of the scoping system.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
PropagatedstringCIM_System.CreationClassNameNone OVERRIDABLE= false
SystemNamestring
DescriptionstringThe System Name of the scoping system.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
PropagatedstringCIM_System.NameNone OVERRIDABLE= false
TimeOfLastResetdatetime
DescriptionstringTime of the last reset of the Printer Device.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|SNMPv2-MIB.sysUpTime, MIB.IETF|HOST-RESOURCES-MIB.hrSystemUptime, MIB.IETF|HOST-RESOURCES-MIB.hrSystemDate, RFC2911.IETF|Section 4.4.29 printer-up-time, RFC2911.IETF|Section 4.4.30 printer-current-timeNone None
TimeOfLastStateChangedatetime
DescriptionstringThe date or time when the EnabledState of the element last changed. If the state of the element has not changed and this property is populated, then it must be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property must not be updated.None TRANSLATABLE= true
TotalPowerOnHoursuint64
CounterbooleantrueNone None
DeprecatedstringCIM_PoweredStatisticalData.TotalPowerOnHoursTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method is deprecated. Deprecated description: The total number of hours that this Device has been powered on.None TRANSLATABLE= true
PUnitstringhourNone None
UnitsstringHoursNone TRANSLATABLE= true
TransitioningToStateuint16
DescriptionstringTransitioningToState indicates the target state to which the instance is transitioning. A value of 5 "No Change" shall indicate that no transition is in progress.A value of 12 "Not Applicable" shall indicate the implementation does not support representing ongoing transitions. A value other than 5 or 12 shall identify the state to which the element is in the process of transitioning.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
ModelCorrespondencestringCIM_EnabledLogicalElement.RequestStateChange, CIM_EnabledLogicalElement.RequestedState, CIM_EnabledLogicalElement.EnabledStateNone None
ValueMapstring0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12None None
ValuesstringUnknown, Enabled, Disabled, Shut Down, No Change, Offline, Test, Defer, Quiesce, Reboot, Reset, Not ApplicableNone TRANSLATABLE= true
VerticalResolutionuint32
DeprecatedstringCIM_PrintMarker.FeedAddressabilityTOSUBCLASS= falseNone
DescriptionstringNote: The use of this property has been deprecated, due to ambiguity. Instead use the FeedAddressability property in the Printer component classes PrintMarker and PrintInterpreter. Deprecated description: The resolution of the Printer in Pixels per Inch in the feed direction, i.e., long-edge in portrait feed mode.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|Printer-MIB.prtMarkerAddressabilityFeedDir, RFC2911.IETF|Section 4.2.12 printer-resolutionNone None
ModelCorrespondencestringCIM_PrintJob.VerticalResolutionNone None
PUnitstringpixel / inchNone None
UnitsstringPixels per InchNone TRANSLATABLE= true

Copyright © 2008-2010 VMware, Inc. All rights reserved.