// Copyright (c) 2007 DMTF. All rights reserved.
// ==================================================================
// CIM_PrintAlertRecord
// ==================================================================
[Experimental, Version ( "2.17.0" ),
UMLPackagePath ( "CIM::Device::Printing" ), Description (
"This class represents an alert (warning or critical event) on "
"a Printer (print device). A critical alert is one that stops "
"the Printer from printing immediately and printing cannot "
"continue until the critical alert condition is eliminated. "
"Non-critical alerts are those alerts that do not stop printing "
"immediately, but may do so at some future time. A "
"PrintAlertRecord shall be associated with exactly one Printer "
"via an instance of the PrintAlertLog class. See: Model in "
"section 2 of Printer MIB (RFC 3805) and section 3 of Finisher "
"MIB (RFC 3806)."),
MappingStrings { "MIB.IETF|Printer-MIB.prtAlertEntry" }]
class CIM_PrintAlertRecord : CIM_LogEntry {
[Description (
"A unique value used by the Printer to identify this "
"specific PrintAlertRecord. If the alert identifier is "
"unknown or not applicable, then this property shall be "
"null. Note: This property is necessary to correlate status "
"and event (alert) information between CIM and SNMP "
"interfaces."),
MinValue ( 1 ), MaxValue ( 2147483647 ),
MappingStrings { "MIB.IETF|Printer-MIB.prtAlertIndex" },
ModelCorrespondence { "CIM_PrinterElement.SNMPRowId" }]
uint32 SNMPRowId;
[Description (
"A free-form text description of this alert in the "
"localization specified by "
"CIM_Printer.CurrentNaturalLanguage."),
MinLen ( 0 ), MaxLen ( 255 ),
MappingStrings { "MIB.IETF|Printer-MIB.prtAlertDescription",
"MIB.IETF|Printer-MIB.PrtLocalizedDescriptionStringTC" }]
string LocalizedDescription;
[Description (
"The code name that describes the type of alert. The code "
"name shall be the IANA-registered label for this alert, "
"taken from the PrtAlertCodeTC textual convention in the "
"IANA Printer MIB (originally published in RFC 3805), e.g., "
"'coverOpen' or 'inputMediaSupplyLow'. A binary change alert "
"describes the state of the component, while a unary change "
"alert describes a single event. The same code name can be "
"used for a binary change alert or a unary change alert, "
"depending on implementation. Also, the same code name can "
"be used to indicate a critical or non-critical (warning) "
"alert, depending on implementation. The value of the "
"SeverityLevel property specifies binary versus unary and "
"critical versus non-critical for each alert for this "
"particular Printer implementation. The value of the "
"TrainingLevel property specifies the level of information "
"or training that is required to handle this alert for this "
"Printer implementation."),
MinLen ( 0 ), MaxLen ( 255 ),
MappingStrings { "MIB.IETF|Printer-MIB.prtAlertCode",
"MIB.IETF|IANA-PRINTER-MIB.PrtAlertCodeTC" },
ModelCorrespondence { "CIM_PrintAlertRecord.OtherCodeName",
"CIM_PrintAlertRecord.SeverityLevel",
"CIM_PrintAlertRecord.TrainingLevel" }]
string CodeName;
[Description (
"A free-form string that describes the type of alert when "
"the value of the CodeName property is equal to 'other'."),
MinLen ( 0 ), MaxLen ( 255 ),
ModelCorrespondence { "CIM_PrintAlertRecord.CodeName" }]
string OtherCodeName;
[Description (
"The level of severity of this alert in this Printer "
"implementation as follows: 1 (Other) means a non-standard "
"severity level is present in OtherSeverityLevel property. 2 "
"(Unknown) means severity level is unknown for this alert. 3 "
"(Critical) means that this alert on this component has "
"stopped printing on this Printer. 4 (Warning) means that "
"this alert has not stopped printing on this Printer. 5 "
"(WarningBinaryChangeEvent) means that a previous critical "
"alert condition has been cleared and the value of the "
"ComponentSNMPRowId specifies the value of "
"CIM_PrintAlertRecord.SNMPRowId for the original alert."),
ValueMap { "1", "2", "3", "4", "5", ".." },
Values { "Other", "Unknown", "Critical", "Warning",
"WarningBinaryChangeEvent", "DMTF Reserved" },
MappingStrings { "MIB.IETF|Printer-MIB.prtAlertSeverityLevel",
"MIB.IETF|Printer-MIB.PrtAlertSeverityLevelTC" },
ModelCorrespondence { "CIM_PrintAlertRecord.CodeName",
"CIM_PrintAlertRecord.TrainingLevel" }]
uint32 SeverityLevel;
[Description (
"A free-form string that describes the severity level when "
"the value of the SeverityLevel property is equal to 1 "
"(Other)."),
MinLen ( 0 ), MaxLen ( 255 ),
ModelCorrespondence { "CIM_PrintAlertRecord.SeverityLevel" }]
string OtherSeverityLevel;
[Description (
"The level of training required to handle this alert in this "
"Printer implementation as follows: 1 (Other) - alert has a "
"non-standard training level specified in the "
"OtherTrainingLevel property; 2 (Unknown) - alert has an "
"unknown training level; 3 (Untrained) - alert that can be "
"fixed without prior training either because the action to "
"correct the alert is obvious or the Printer can help the "
"untrained person fix the problem - a typical example of "
"such an alert is reloading paper trays or emptying output "
"bins on a low end Printer; 4 (Trained) - alert that "
"requires an intermediate or moderate knowledge of the "
"Printer and its components - a typical example of such an "
"alert is an empty toner cartridge; 5 (FieldService) - alert "
"that typically requires advanced training and technical "
"knowledge of the Printer and its components - an example of "
"a technical person would be a manufacturer's Field Service "
"representative, or other person formally trained by the "
"manufacturer or similar representative; 6 (Management) - "
"alert that has to do with overall operation of and "
"configuration of the Printer - an example of a management "
"event is the configuration change of a component; 7 "
"(NoInterventionRequired) - alert does not require human "
"intervention."),
ValueMap { "1", "2", "3", "4", "5", "6", "7", ".." },
Values { "Other", "Unknown", "Untrained", "Trained",
"FieldService", "Management", "NoInterventionRequired",
"DMTF Reserved" },
MappingStrings { "MIB.IETF|Printer-MIB.prtAlertTrainingLevel",
"MIB.IETF|IANA-PRINTER-MIB.PrtAlertTrainingLevelTC" },
ModelCorrespondence { "CIM_PrintAlertRecord.CodeName",
"CIM_PrintAlertRecord.SeverityLevel" }]
uint32 TrainingLevel;
[Description (
"A free-form string that describes the training level when "
"the value of the TrainingLevel property is equal to 1 "
"(Other)."),
MinLen ( 0 ), MaxLen ( 255 ),
ModelCorrespondence { "CIM_PrintAlertRecord.TrainingLevel" }]
string OtherTrainingLevel;
[Description (
"The lowest inheritance class name with a schema name of "
"'CIM' (e.g., 'CIM_PrintMarker') of the particular component "
"of a Printer with which this alert is associated. When used "
"with the value of ComponentElementName, this property "
"allows all instances of this component to be uniquely "
"identified. If the component class name is unknown or not "
"applicable, then this property shall be null. See: Section "
"2 of the Printer MIB v2 (RFC 3805). and section 3 of "
"Finisher MIB (RFC 3806). Note: This property is necessary "
"to correlate status and event (alert) information between "
"CIM and SNMP interfaces."),
MinLen ( 0 ), MaxLen ( 255 ),
MappingStrings { "MIB.IETF|Printer-MIB.prtAlertGroup",
"MIB.IETF|IANA-PRINTER-MIB.PrtAlertGroupTC" },
ModelCorrespondence {
"CIM_PrintAlertRecord.ComponentElementName",
"CIM_PrintAlertRecord.ComponentSNMPRowId",
"CIM_PrintAlertRecord.ComponentLocation" }]
string ComponentClassName;
[Description (
"The value of the ManagedSystemElement.Name property of the "
"particular component of a Printer with which this alert is "
"associated. When used with the value of ComponentClassName, "
"this property allows all instances of this component to be "
"uniquely identified. If the component element name is "
"unknown or not applicable, then this property shall be "
"null. See: Section 2 of the Printer MIB v2 (RFC 3805). and "
"section 3 of Finisher MIB (RFC 3806). Note: This property "
"is necessary to correlate status and event (alert) "
"information between CIM and SNMP interfaces."),
MinLen ( 0 ), MaxLen ( 255 ),
MappingStrings { "MIB.IETF|Printer-MIB.prtAlertGroupIndex" },
ModelCorrespondence { "CIM_ManagedSystemElement.Name",
"CIM_PrintAlertRecord.ComponentClassName",
"CIM_PrintAlertRecord.ComponentSNMPRowId",
"CIM_PrintAlertRecord.ComponentLocation" }]
string ComponentElementName;
[Description (
"A unique value used by the Printer to identify the specific "
"component associated with this alert. If the component "
"identifier is unknown or not applicable, then this property "
"shall be null. See: Section 2 of the Printer MIB v2 (RFC "
"3805). and section 3 of Finisher MIB (RFC 3806). Note: This "
"property is necessary to correlate status and event (alert) "
"information between CIM and SNMP interfaces."),
MinValue ( 0 ), MaxValue ( 2147483647 ),
MappingStrings { "MIB.IETF|Printer-MIB.prtAlertGroupIndex" },
ModelCorrespondence { "CIM_PrinterElement.SNMPRowId",
"CIM_PrintAlertRecord.ComponentClassName",
"CIM_PrintAlertRecord.ComponentElementName",
"CIM_PrintAlertRecord.ComponentLocation" }]
uint32 ComponentSNMPRowId;
[Description (
"The component location that is defined by the Printer "
"manufacturer to further refine the location of this alert "
"within the particular component. The component location is "
"used in conjunction with the value of the "
"ComponentClassName and ComponentElementName properties. If "
"the component location is unknown or not applicable, then "
"this property shall be null. See: Section 2 of the Printer "
"MIB v2 (RFC 3805). and section 3 of Finisher MIB (RFC "
"3806). Note: This property is necessary to correlate status "
"and event (alert) information between CIM and SNMP "
"interfaces."),
MinValue ( 0 ), MaxValue ( 2147483647 ),
MappingStrings { "MIB.IETF|Printer-MIB.prtAlertLocation" },
ModelCorrespondence { "CIM_PrintAlertRecord.ComponentClassName",
"CIM_PrintAlertRecord.ComponentElementName",
"CIM_PrintAlertRecord.ComponentSNMPRowId" }]
uint32 ComponentLocation;
[Override ( "CreationTimeStamp" ), Description (
"The time that this PrintAlertRecord was generated."),
MappingStrings { "MIB.IETF|Printer-MIB.prtAlertTime",
"MIB.IETF|SNMPv2-MIB.sysUpTime",
"MIB.IETF|HOST-RESOURCES-MIB.hrSystemUptime",
"MIB.IETF|HOST-RESOURCES-MIB.hrSystemDate" },
ModelCorrespondence { "CIM_OperatingSystem.LocalDateTime" }]
datetime CreationTimeStamp;
};
|