Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary
CIM_PrintAlertRecord --> CIM_LogEntry --> CIM_RecordForLog --> CIM_ManagedElement --> [top]
Class Declaration Attributes Name Value SUPERCLASS CIM_LogEntry NAME CIM_PrintAlertRecord
Class CIM_PrintAlertRecord Qualifiers Name Type Value From Class Experimental boolean true CIM_PrintAlertRecord Version string 2.17.0 CIM_PrintAlertRecord UMLPackagePath string CIM::Device::Printing CIM_PrintAlertRecord Description string 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 is a snapshot of the state of the device at the time an alert condition occurs. It is preserved in a format that is suitable for offline processing, when the device may have changed or may not be available for interrogation. 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). CIM_PrintAlertRecord MappingStrings string MIB.IETF|Printer-MIB.prtAlertEntry CIM_PrintAlertRecord UMLPackagePath string CIM::System::Logs CIM_LogEntry Description string The LogEntry object can describe the definitional format for entries in a Log, or can be used to instantiate the actual entries in the Log. CIM_LogEntry UMLPackagePath string CIM::System::Logs CIM_RecordForLog Description string The RecordForLog class is used to instantiate records to be aggregated to a Log. CIM_RecordForLog UMLPackagePath string CIM::Core::CoreElements CIM_ManagedElement Description string ManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema. CIM_ManagedElement
Property Qualifiers
Property CreationTimeStamp Qualifiers Name Type Value From Class Description string The time that this PrintAlertRecord was generated. CIM_PrintAlertRecord MappingStrings string MIB.IETF|Printer-MIB.prtAlertTime
MIB.IETF|SNMPv2-MIB.sysUpTime
MIB.IETF|HOST-RESOURCES-MIB.hrSystemUptime
MIB.IETF|HOST-RESOURCES-MIB.hrSystemDateCIM_PrintAlertRecord ModelCorrespondence string CIM_OperatingSystem.LocalDateTime CIM_PrintAlertRecord
Property RecordData Qualifiers Name Type Value From Class Description string Note: For SNMP Proxy implementations, this property shall contain every integer object defined in the prtAlertEntry row in the Printer MIB v2 (RFC 3805), using a delimiter of semi-colon ';' as 'keyword=value' tuples, where each keyword is the label from the Printer MIB object (e.g., prtAlertIndex) and each value is the decimal string encoding of the original MIB integer value. For example, prtAlertIndex=34;...;prtAlertTime=34567; Note: The only string object defined in the prtAlertEntry row (prtAlertDescription) shall not be encoded in this RecordData property, but shall instead be transcoded (if necessary) into Unicode and stored in the LocalizedDescription property below. CIM_PrintAlertRecord MappingStrings string MIB.IETF|Printer-MIB.prtAlertEntry CIM_PrintAlertRecord ModelCorrespondence string CIM_RecordForLog.RecordFormat CIM_PrintAlertRecord
Property LocalizedDescription Qualifiers Name Type Value From Class Description string A free-form text description of this alert in the localization specified by CIM_Printer.CurrentNaturalLanguage. CIM_PrintAlertRecord MinLen uint32 0 CIM_PrintAlertRecord MaxLen uint32 255 CIM_PrintAlertRecord MappingStrings string MIB.IETF|Printer-MIB.prtAlertDescription
MIB.IETF|Printer-MIB.PrtLocalizedDescriptionStringTCCIM_PrintAlertRecord
Property CodeName Qualifiers Name Type Value From Class Description string 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. CIM_PrintAlertRecord MinLen uint32 0 CIM_PrintAlertRecord MaxLen uint32 255 CIM_PrintAlertRecord MappingStrings string MIB.IETF|Printer-MIB.prtAlertCode
MIB.IETF|IANA-PRINTER-MIB.PrtAlertCodeTCCIM_PrintAlertRecord ModelCorrespondence string CIM_PrintAlertRecord.OtherCodeName
CIM_PrintAlertRecord.SeverityLevelCIM_PrintAlertRecord
Property OtherCodeName Qualifiers Name Type Value From Class Description string A free-form string that describes the type of alert when the value of the CodeName property is equal to 'other'. CIM_PrintAlertRecord MinLen uint32 0 CIM_PrintAlertRecord MaxLen uint32 255 CIM_PrintAlertRecord ModelCorrespondence string CIM_PrintAlertRecord.CodeName CIM_PrintAlertRecord
Property SeverityLevel Qualifiers Name Type Value From Class Description string 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. CIM_PrintAlertRecord ValueMap string [See below.] CIM_PrintAlertRecord Values string Other
Unknown
Critical
Warning
WarningBinaryChangeEvent
DMTF ReservedCIM_PrintAlertRecord MappingStrings string MIB.IETF|Printer-MIB.prtAlertSeverityLevel
MIB.IETF|Printer-MIB.PrtAlertSeverityLevelTCCIM_PrintAlertRecord ModelCorrespondence string CIM_PrintAlertRecord.CodeName CIM_PrintAlertRecord
Name Value 1 Other 2 Unknown 3 Critical 4 Warning 5 WarningBinaryChangeEvent .. DMTF Reserved
Property OtherSeverityLevel Qualifiers Name Type Value From Class Description string A free-form string that describes the severity level when the value of the SeverityLevel property is equal to 1 (Other). CIM_PrintAlertRecord MinLen uint32 0 CIM_PrintAlertRecord MaxLen uint32 255 CIM_PrintAlertRecord ModelCorrespondence string CIM_PrintAlertRecord.SeverityLevel CIM_PrintAlertRecord
Property ComponentClassName Qualifiers Name Type Value From Class Description string 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. Note: This property is necessary (rather than the use of an association class), because this log entry is static and records a past event for offline processing. 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. CIM_PrintAlertRecord MinLen uint32 0 CIM_PrintAlertRecord MaxLen uint32 255 CIM_PrintAlertRecord MappingStrings string MIB.IETF|Printer-MIB.prtAlertGroup
MIB.IETF|IANA-PRINTER-MIB.PrtAlertGroupTCCIM_PrintAlertRecord ModelCorrespondence string CIM_PrintAlertRecord.ComponentElementName CIM_PrintAlertRecord
Property ComponentElementName Qualifiers Name Type Value From Class Description string 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. Note: This property is necessary (rather than the use of an association class), because this log entry is static and records a past event for offline processing. 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. CIM_PrintAlertRecord MinLen uint32 0 CIM_PrintAlertRecord MaxLen uint32 255 CIM_PrintAlertRecord MappingStrings string MIB.IETF|Printer-MIB.prtAlertGroupIndex CIM_PrintAlertRecord ModelCorrespondence string CIM_ManagedSystemElement.Name
CIM_PrintAlertRecord.ComponentClassNameCIM_PrintAlertRecord
Property InstanceID Qualifiers Name Type Value From Class Key boolean true CIM_LogEntry Description string Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order 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 creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority (This 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 re-used to identify different underlying (real-world) elements. If the above 'preferred' algorithm is not used, the defining entity MUST assure that the resultant InstanceID is not re-used across any InstanceIDs produced by this or other providers for this instance's NameSpace. For DMTF defined instances, the 'preferred' algorithm MUST be used with the <OrgID> set to 'CIM'. CIM_LogEntry
Property LogInstanceID Qualifiers Name Type Value From Class Description string The containing Log's InstanceID. CIM_LogEntry MaxLen uint32 256 CIM_LogEntry
Property LogName Qualifiers Name Type Value From Class Description string The containing Log's Name. This property is available for backwards continuity with CIM_LogRecord. CIM_LogEntry MaxLen uint32 256 CIM_LogEntry
Property RecordID Qualifiers Name Type Value From Class Description string RecordID may be used to provide a representation of log entry ordering or pointers/handles for log entries. CIM_LogEntry MaxLen uint32 256 CIM_LogEntry
Property CreationTimeStamp Qualifiers Name Type Value From Class Description string A LogEntry may include a timestamp for the entry. CIM_LogEntry
Property OwningEntity Qualifiers Name Type Value From Class Description string A string that uniquely identifies the entity that owns the definition of the format of the Message described in this instance. OwningEntity MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity or standards body defining the format. CIM_LogEntry
Property MessageID Qualifiers Name Type Value From Class Description string A string that uniquely identifies, within the scope of the OwningEntity, the format of the Message. CIM_LogEntry ModelCorrespondence string CIM_LogEntry.Message
CIM_LogEntry.MessageArgumentsCIM_LogEntry
Property Message Qualifiers Name Type Value From Class Description string The formatted message. This message is constructed by combining some or all of the dynamic elements specified in the MessageArguments property with the static elements uniquely identified by the MessageID in a message registry or other catalog associated with the OwningEntity. CIM_LogEntry ModelCorrespondence string CIM_LogEntry.MessageID
CIM_LogEntry.MessageArgumentsCIM_LogEntry
Property MessageArguments Qualifiers Name Type Value From Class Description string An array containing the dynamic content of the message. CIM_LogEntry ModelCorrespondence string CIM_LogEntry.Message
CIM_LogEntry.MessageIDCIM_LogEntry
Property RecordFormat Qualifiers Name Type Value From Class Description string A string describing the data structure of the information in the property, RecordData. If the RecordFormat string is <empty>, RecordData should be interpreted as a free-form string. To describe the data structure of RecordData, the RecordFormat string should be constructed as follows: - The first character is a delimiter character and is used to parse the remainder of the string into sub-strings. - Each sub-string is separated by the delimiter character and should be in the form of a CIM property declaration (i.e., datatype and property name). This set of declarations may be used to interpret the similarly delimited RecordData property. For example, using a '*' delimiter, RecordFormat = "*string ThisDay*uint32 ThisYear*datetime SomeTime"may be used to interpret: RecordData = "*This is Friday*2002*20020807141000.000000-300". CIM_RecordForLog ModelCorrespondence string CIM_RecordForLog.RecordData CIM_RecordForLog
Property RecordData Qualifiers Name Type Value From Class Description string A string containing LogRecord data. If the corresponding RecordFormat property is <empty>, or cannot be parsed according to the recommended format, RecordData should be interpreted as a free-form string. If the RecordFormat property contains parseable format information (as recommended in the RecordFormat Description qualifier), the RecordData string SHOULD be parsed in accordance with this format. In this case, RecordData SHOULD begin with the delimiter character and this character SHOULD be used to separate substrings in the manner described. The RecordData string can then be parsed by the data consumer and appropriately typed. CIM_RecordForLog ModelCorrespondence string CIM_RecordForLog.RecordFormat CIM_RecordForLog
Property Locale Qualifiers Name Type Value From Class Description string This property is being deprecated to avoid conflicts with localization implementations using CIM/XML over HTTP protocol, the preferred mechanism. A locale indicates a particular geographical, political, or cultural region. The Locale specifies the language used in creating the RecordForLog data. If the Locale property is empty, it is assumed that the default locale is en_US (English). The locale string consists of three sub-strings, separated by underscores: - The first sub-string is the language code, as specified in ISO639. - The second sub-string is the country code, as specified in ISO3166. - The third sub-string is a variant, which is vendor specific. For example, US English appears as: "en_US_WIN", where the "WIN" variant would specify a Windows browser-specific collation (if one exists). Since the variant is not standardized, it is not commonly used and generally is limited to easily recognizable values ("WIN", "UNIX", "EURO", etc.) used in standard environments. The language and country codes are required; the variant may be empty. CIM_RecordForLog
Property Caption Qualifiers Name Type Value From Class Description string The Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement MaxLen uint32 64 CIM_ManagedElement
Property Description Qualifiers Name Type Value From Class Description string The Description property provides a textual description of the object. CIM_ManagedElement
Property ElementName Qualifiers Name Type Value From Class Description string A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information. Note that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties. CIM_ManagedElement
Method Qualifiers
Parameters
Parameter Qualifiers