| Name | Data Type | Qualifiers |
| Name | Data Type | Value | Scope | Flavors |
| Caption | string |
| Description | string | The Caption property is a short textual description (one- line string) of the object. | None | TRANSLATABLE= true |
| MaxLen | uint32 | 64 | None | None |
| CodeName | string |
| 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. | None | TRANSLATABLE= true |
| MappingStrings | string | MIB.IETF|Printer-MIB.prtAlertCode, MIB.IETF|IANA-PRINTER-MIB.PrtAlertCodeTC | None | None |
| MaxLen | uint32 | 255 | None | None |
| MinLen | uint32 | 0 | None | None |
| ModelCorrespondence | string | CIM_PrintAlertRecord.OtherCodeName, CIM_PrintAlertRecord.SeverityLevel | None | None |
| ComponentClassName | string |
| 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. | None | TRANSLATABLE= true |
| MappingStrings | string | MIB.IETF|Printer-MIB.prtAlertGroup, MIB.IETF|IANA-PRINTER-MIB.PrtAlertGroupTC | None | None |
| MaxLen | uint32 | 255 | None | None |
| MinLen | uint32 | 0 | None | None |
| ModelCorrespondence | string | CIM_PrintAlertRecord.ComponentElementName | None | None |
| ComponentElementName | string |
| 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. | None | TRANSLATABLE= true |
| MappingStrings | string | MIB.IETF|Printer-MIB.prtAlertGroupIndex | None | None |
| MaxLen | uint32 | 255 | None | None |
| MinLen | uint32 | 0 | None | None |
| ModelCorrespondence | string | CIM_ManagedSystemElement.Name, CIM_PrintAlertRecord.ComponentClassName | None | None |
| CreationTimeStamp | datetime |
| Description | string | The time that this PrintAlertRecord was generated. | None | TRANSLATABLE= true |
| MappingStrings | string | MIB.IETF|Printer-MIB.prtAlertTime, MIB.IETF|SNMPv2-MIB.sysUpTime, MIB.IETF|HOST-RESOURCES-MIB.hrSystemUptime, MIB.IETF|HOST-RESOURCES-MIB.hrSystemDate | None | None |
| ModelCorrespondence | string | CIM_OperatingSystem.LocalDateTime | None | None |
| Override | string | CreationTimeStamp | TOSUBCLASS= false | None |
| Description | string |
| Description | string | The Description property provides a textual description of the object. | None | TRANSLATABLE= true |
| ElementName | string |
| 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. | None | TRANSLATABLE= true |
| Generation | uint64 |
| Description | string | Generation 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 |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| InstanceID | string |
| 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'. | None | TRANSLATABLE= true |
| Key | boolean | true | None | OVERRIDABLE= false
|
| Override | string | InstanceID | TOSUBCLASS= false | None |
| Locale | string |
| Deprecated | string | No Value | TOSUBCLASS= false | None |
| 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. | None | TRANSLATABLE= true |
| LocalizedDescription | string |
| Description | string | A free-form text description of this alert in the localization specified by CIM_Printer.CurrentNaturalLanguage. | None | TRANSLATABLE= true |
| MappingStrings | string | MIB.IETF|Printer-MIB.prtAlertDescription, MIB.IETF|Printer-MIB.PrtLocalizedDescriptionStringTC | None | None |
| MaxLen | uint32 | 255 | None | None |
| MinLen | uint32 | 0 | None | None |
| LogInstanceID | string |
| Description | string | The containing Log's InstanceID. | None | TRANSLATABLE= true |
| MaxLen | uint32 | 256 | None | None |
| LogName | string |
| Description | string | The containing Log's Name. This property is available for backwards continuity with CIM_LogRecord. | None | TRANSLATABLE= true |
| MaxLen | uint32 | 256 | None | None |
| Message | string |
| 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. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| ModelCorrespondence | string | CIM_LogEntry.MessageID, CIM_LogEntry.MessageArguments | None | None |
| MessageArguments | string |
| Description | string | An array containing the dynamic content of the message. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| ModelCorrespondence | string | CIM_LogEntry.Message, CIM_LogEntry.MessageID | None | None |
| MessageID | string |
| Description | string | A string that uniquely identifies, within the scope of the OwningEntity, the format of the Message. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| ModelCorrespondence | string | CIM_LogEntry.Message, CIM_LogEntry.MessageArguments | None | None |
| OtherCodeName | string |
| Description | string | A free-form string that describes the type of alert when the value of the CodeName property is equal to 'other'. | None | TRANSLATABLE= true |
| MaxLen | uint32 | 255 | None | None |
| MinLen | uint32 | 0 | None | None |
| ModelCorrespondence | string | CIM_PrintAlertRecord.CodeName | None | None |
| OtherSeverityLevel | string |
| Description | string | A free-form string that describes the severity level when the value of the SeverityLevel property is equal to 1 (Other). | None | TRANSLATABLE= true |
| MaxLen | uint32 | 255 | None | None |
| MinLen | uint32 | 0 | None | None |
| ModelCorrespondence | string | CIM_PrintAlertRecord.SeverityLevel | None | None |
| OwningEntity | string |
| 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. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| PerceivedSeverity | uint16 |
| Description | string | An enumerated value that describes the severity of the Indication from the notifier's point of view:
1 - Other, by CIM convention, is used to indicate that the Severity's value can be found in the OtherSeverity property.
3 - Degraded/Warning should be used when its appropriate to let the user decide if action is needed.
4 - Minor should be used to indicate action is needed, but the situation is not serious at this time.
5 - Major should be used to indicate action is needed NOW.
6 - Critical should be used to indicate action is needed NOW and the scope is broad (perhaps an imminent outage to a critical resource will result).
7 - Fatal/NonRecoverable should be used to indicate an error occurred, but it's too late to take remedial action.
2 and 0 - Information and Unknown (respectively) follow common usage. Literally, the Indication is purely informational or its severity is simply unknown. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| MappingStrings | string | Recommendation.ITU|X733.Perceived severity | None | None |
| ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7 | None | None |
| Values | string | Unknown, Other, Information, Degraded/Warning, Minor, Major, Critical, Fatal/NonRecoverable | None | TRANSLATABLE= true |
| RecordData | string |
| 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. | None | TRANSLATABLE= true |
| MappingStrings | string | MIB.IETF|Printer-MIB.prtAlertEntry | None | None |
| ModelCorrespondence | string | CIM_RecordForLog.RecordFormat | None | None |
| Override | string | RecordData | TOSUBCLASS= false | None |
| RecordFormat | string |
| 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". | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_RecordForLog.RecordData | None | None |
| RecordID | string |
| Description | string | RecordID may be used to provide a representation of log entry ordering or pointers/handles for log entries. | None | TRANSLATABLE= true |
| MaxLen | uint32 | 256 | None | None |
| SeverityLevel | uint32 |
| 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. | None | TRANSLATABLE= true |
| MappingStrings | string | MIB.IETF|Printer-MIB.prtAlertSeverityLevel, MIB.IETF|Printer-MIB.PrtAlertSeverityLevelTC | None | None |
| ModelCorrespondence | string | CIM_PrintAlertRecord.CodeName | None | None |
| ValueMap | string | 1, 2, 3, 4, 5, .. | None | None |
| Values | string | Other, Unknown, Critical, Warning, WarningBinaryChangeEvent, DMTF Reserved | None | TRANSLATABLE= true |
Copyright © 2008-2010 VMware, Inc. All rights reserved.