Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary
CIM_DiagnosticCompletionRecord --> CIM_DiagnosticServiceRecord --> CIM_DiagnosticRecord --> CIM_RecordForLog --> CIM_ManagedElement --> [top]
Class Declaration Attributes Name Value SUPERCLASS CIM_DiagnosticServiceRecord NAME CIM_DiagnosticCompletionRecord
Class CIM_DiagnosticCompletionRecord Qualifiers Name Type Value From Class Version string 2.11.0 CIM_DiagnosticCompletionRecord Description string When a DiagnosticService has completed, results generated by the service will be recorded in a DiagnosticCompletionRecord object. This class is used when a DiagnosticRecord.RecordType value = " Results " , to contain completion information. CIM_DiagnosticCompletionRecord Description string While a DiagnosticService is running, data generated by the service may be recorded in DiagnosticServiceRecord objects. A DiagnosticServiceRecord is related to its Log via an instance of the LogManagesRecord aggregation class. CIM_DiagnosticServiceRecord Description string Data related to Diagnostics may be recorded in various DiagnosticRecord objects. The type of information that is recorded in a log is specified via the LogOptions property in DiagnosticSettingData. CIM_DiagnosticRecord Description string The RecordForLog class is used to instantiate records to be aggregated to a Log. CIM_RecordForLog 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 CompletionState Qualifiers Name Type Value From Class Description string This property is used when a DiagnosticRecord.RecordType value = " Results " , to record how the test has completed. It is expected that additional DiagnosticServiceRecords of RecordType " Service Errors " , " Warning " or " Device Errors " would be created by the test to describe the details of a " Warning " , " Incomplete " or " Failed " CompletionState, respectively. " Stopped " and " Aborted " are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the element ’ s state and configuration may need to be updated. " Warning " means the element had a problem but did not fail the test. " Failed " and " Incomplete " are similar, although the former means the test on the element failed, while the latter means the test itself had a problem and could not complete execution. CIM_DiagnosticCompletionRecord ValueMap string [See below.] CIM_DiagnosticCompletionRecord Values string Unknown
Other
OK
Warning
Incomplete
Failed
Aborted
StoppedCIM_DiagnosticCompletionRecord ModelCorrespondence string CIM_DiagnosticCompletionRecord.OtherCompletionStateDescription CIM_DiagnosticCompletionRecord
Name Value 0 Unknown 1 Other 2 OK 3 Warning 4 Incomplete 5 Failed 6 Aborted 7 Stopped
Property OtherCompletionStateDescription Qualifiers Name Type Value From Class Description string When " Other " (value=1) is entered in the CompletionState property, OtherCompletionStateDescription can be used to describe the test ’ s state. CIM_DiagnosticCompletionRecord ModelCorrespondence string CIM_DiagnosticCompletionRecord.CompletionState CIM_DiagnosticCompletionRecord
Property ErrorCode Qualifiers Name Type Value From Class Description string If applicable, this string should contain one or more vendor specific error codes that the diagnostic service detected. These error codes may be used by the vendor for variety of purposes such as: fault data base indexing, field service trouble ticketing, product quality tracking, part failure history, etc. Since these codes are for vendor purposes they may assume any form. Details on suggested use cases will be left to white papers. The array of error codes has model correspondence with an ErrorCount array so the number of errors reported can be analyzed by individual error code. CIM_DiagnosticServiceRecord ArrayType string Indexed CIM_DiagnosticServiceRecord ModelCorrespondence string CIM_DiagnosticServiceRecord.ErrorCount CIM_DiagnosticServiceRecord
Property ErrorCount Qualifiers Name Type Value From Class Description string Since some tests may detect transient and correctable errors such as a network diagnostic or memory test, an error count is useful to indicate the severity of the failure. This field contains an integer value of the number of errors detected by the test. The ErrorCount is an array with model correspondence to ErrorCode so that the test can report an ErrorCount on each type of error encountered. It is recommended that hard errors and correctable or recoverable errors be given different codes so that clients with knowledge of the error codes can evaluate correctable, recoverable, and hard errors independently. CIM_DiagnosticServiceRecord ArrayType string Indexed CIM_DiagnosticServiceRecord ModelCorrespondence string CIM_DiagnosticServiceRecord.ErrorCode CIM_DiagnosticServiceRecord
Property LoopsFailed Qualifiers Name Type Value From Class Description string Since some tests may be looped, it is useful to report how many iterations passed and failed. This is relevant in analyzing transitory failures. For example, if all the errors occurred in just one of 100 iterations, the device may be viewed as OK or marginal, to be monitored further rather then failed. Note: LoopsPassed & LoopsFailed should add up to the loops completed. A value for this property would likely be reported with a DiagnosticServiceRecord.RecordType value = " Results " , which contains a result covering all iterations of a looped service. CIM_DiagnosticServiceRecord
Property LoopsPassed Qualifiers Name Type Value From Class Description string Since some tests may be looped, it is useful to report how many iterations passed and failed. This is relevant in analyzing transitory failures. For example if all the errors occurred in just one of 100 iterations, the device may be viewed as OK or marginal, to be monitored further rather then failed. Note: LoopsPassed & LoopsFailed should add up to the loops completed. A value for this property would likely be reported with a DiagnosticServiceRecord.RecordType value = " Results " , which contains a result covering all iterations of a looped service. CIM_DiagnosticServiceRecord
Property InstanceID Qualifiers Name Type Value From Class Key boolean true CIM_DiagnosticRecord 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_DiagnosticRecord
Property ServiceName Qualifiers Name Type Value From Class Required boolean true CIM_DiagnosticRecord Description string This property should reflect the value of the underlying DiagnosticService.Name property. CIM_DiagnosticRecord ModelCorrespondence string CIM_DiagnosticService.Name CIM_DiagnosticRecord
Property ManagedElementName Qualifiers Name Type Value From Class Required boolean true CIM_DiagnosticRecord Description string This property SHOULD reflect the value of the underlying ManagedElement.ElementName property. CIM_DiagnosticRecord ModelCorrespondence string CIM_ManagedElement.ElementName CIM_DiagnosticRecord
Property ExpirationDate Qualifiers Name Type Value From Class Description string The date and time that the record instance should be deleted. The expiration datetime SHOULD be set when the record is fully populated with record data. The value SHOULD be calculated using the ResultPersistence property of the DiagnosticSettingData class. Once the Expiration Date has been reached, record instances SHOULD be deleted as soon as possible. If a ResultPersistence value is not provided, records MAY be deleted at any time. CIM_DiagnosticRecord ModelCorrespondence string CIM_DiagnosticSettingData.ResultPersistence CIM_DiagnosticRecord
Property RecordType Qualifiers Name Type Value From Class Description string The RecordType property specifies the nature of the data being entered into the ServiceRecord. The value in this property should match one of the values indicated by the DiagnosticSettingData.LogOptions property. A brief summary of the various log options can be found in CIM_DiagnosticSettingData.LogOptions. CIM_DiagnosticRecord ValueMap string [See below.] CIM_DiagnosticRecord Values string Unknown
Other
Results
Subtests
Actions
Warnings
Status
Device Errors
Service Errors
Setting Data
Statistics
Hardware Configuration
Software Configuration
References
DebugCIM_DiagnosticRecord ModelCorrespondence string CIM_DiagnosticSettingData.LogOptions
CIM_DiagnosticRecord.OtherRecordTypeDescriptionCIM_DiagnosticRecord
Name Value 0 Unknown 1 Other 2 Results 3 Subtests 4 Actions 5 Warnings 6 Status 7 Device Errors 8 Service Errors 9 Setting Data 10 Statistics 11 Hardware Configuration 12 Software Configuration 13 References 14 Debug
Property OtherRecordTypeDescription Qualifiers Name Type Value From Class Description string When " Other " (value=1) is entered in the RecordType property, OtherRecordTypeDescription can be used to describe the message type. CIM_DiagnosticRecord ModelCorrespondence string CIM_DiagnosticSettingData.OtherLogOptionsDescriptions
CIM_DiagnosticRecord.RecordTypeCIM_DiagnosticRecord
Property CreationTimeStamp Qualifiers Name Type Value From Class Description string A timestamp indicating when the record was created. CIM_DiagnosticRecord
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