CIM211 Class Declaration
CIM_DiagnosticCompletionRecord

Table of Contents:
Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary

Class Hierarchy

CIM_DiagnosticCompletionRecord --> CIM_DiagnosticServiceRecord --> CIM_DiagnosticRecord --> CIM_RecordForLog --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_DiagnosticServiceRecord
NAMECIM_DiagnosticCompletionRecord

Class Qualifiers

Class CIM_DiagnosticCompletionRecord Qualifiers
NameTypeValueFrom Class
Versionstring2.11.0 CIM_DiagnosticCompletionRecord
DescriptionstringWhen 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
DescriptionstringWhile 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
DescriptionstringData 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
DescriptionstringThe RecordForLog class is used to instantiate records to be aggregated to a Log. CIM_RecordForLog
DescriptionstringManagedElement 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

Properties

Properties
NameTypeValueQualifiersClassOrigin
CompletionStateuint16 Description
ValueMap
Values
ModelCorrespondence
CIM_DiagnosticCompletionRecord
OtherCompletionStateDescriptionstring Description
ModelCorrespondence
CIM_DiagnosticCompletionRecord
ErrorCodestring[] Description
ArrayType
ModelCorrespondence
CIM_DiagnosticServiceRecord
ErrorCountuint32[] Description
ArrayType
ModelCorrespondence
CIM_DiagnosticServiceRecord
LoopsFaileduint32 Description CIM_DiagnosticServiceRecord
LoopsPasseduint32 Description CIM_DiagnosticServiceRecord
InstanceIDstring Key
Description
CIM_DiagnosticRecord
ServiceNamestring Required
Description
ModelCorrespondence
CIM_DiagnosticRecord
ManagedElementNamestring Required
Description
ModelCorrespondence
CIM_DiagnosticRecord
ExpirationDatedatetime Description
ModelCorrespondence
CIM_DiagnosticRecord
RecordTypeuint16 Description
ValueMap
Values
ModelCorrespondence
CIM_DiagnosticRecord
OtherRecordTypeDescriptionstring Description
ModelCorrespondence
CIM_DiagnosticRecord
CreationTimeStampdatetime Description CIM_DiagnosticRecord
RecordFormatstring Description
ModelCorrespondence
CIM_RecordForLog
RecordDatastring Description
ModelCorrespondence
CIM_RecordForLog
Localestring Deprecated
Description
CIM_RecordForLog
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement
ElementNamestring Description CIM_ManagedElement

Property Qualifiers

Property CompletionState Qualifiers
NameTypeValueFrom Class
DescriptionstringThis 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
ValueMapstring
[See below.]
CIM_DiagnosticCompletionRecord
ValuesstringUnknown
Other
OK
Warning
Incomplete
Failed
Aborted
Stopped
CIM_DiagnosticCompletionRecord
ModelCorrespondencestringCIM_DiagnosticCompletionRecord.OtherCompletionStateDescription CIM_DiagnosticCompletionRecord

NameValue
0Unknown
1Other
2OK
3Warning
4Incomplete
5Failed
6Aborted
7Stopped
Property OtherCompletionStateDescription Qualifiers
NameTypeValueFrom Class
DescriptionstringWhen " Other " (value=1) is entered in the CompletionState property, OtherCompletionStateDescription can be used to describe the test ’ s state. CIM_DiagnosticCompletionRecord
ModelCorrespondencestringCIM_DiagnosticCompletionRecord.CompletionState CIM_DiagnosticCompletionRecord

Property ErrorCode Qualifiers
NameTypeValueFrom Class
DescriptionstringIf 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
ArrayTypestringIndexed CIM_DiagnosticServiceRecord
ModelCorrespondencestringCIM_DiagnosticServiceRecord.ErrorCount CIM_DiagnosticServiceRecord

Property ErrorCount Qualifiers
NameTypeValueFrom Class
DescriptionstringSince 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
ArrayTypestringIndexed CIM_DiagnosticServiceRecord
ModelCorrespondencestringCIM_DiagnosticServiceRecord.ErrorCode CIM_DiagnosticServiceRecord

Property LoopsFailed Qualifiers
NameTypeValueFrom Class
DescriptionstringSince 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
NameTypeValueFrom Class
DescriptionstringSince 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
NameTypeValueFrom Class
Keybooleantrue CIM_DiagnosticRecord
DescriptionstringWithin 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
NameTypeValueFrom Class
Requiredbooleantrue CIM_DiagnosticRecord
DescriptionstringThis property should reflect the value of the underlying DiagnosticService.Name property. CIM_DiagnosticRecord
ModelCorrespondencestringCIM_DiagnosticService.Name CIM_DiagnosticRecord

Property ManagedElementName Qualifiers
NameTypeValueFrom Class
Requiredbooleantrue CIM_DiagnosticRecord
DescriptionstringThis property SHOULD reflect the value of the underlying ManagedElement.ElementName property. CIM_DiagnosticRecord
ModelCorrespondencestringCIM_ManagedElement.ElementName CIM_DiagnosticRecord

Property ExpirationDate Qualifiers
NameTypeValueFrom Class
DescriptionstringThe 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
ModelCorrespondencestringCIM_DiagnosticSettingData.ResultPersistence CIM_DiagnosticRecord

Property RecordType Qualifiers
NameTypeValueFrom Class
DescriptionstringThe 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
ValueMapstring
[See below.]
CIM_DiagnosticRecord
ValuesstringUnknown
Other
Results
Subtests
Actions
Warnings
Status
Device Errors
Service Errors
Setting Data
Statistics
Hardware Configuration
Software Configuration
References
Debug
CIM_DiagnosticRecord
ModelCorrespondencestringCIM_DiagnosticSettingData.LogOptions
CIM_DiagnosticRecord.OtherRecordTypeDescription
CIM_DiagnosticRecord

NameValue
0Unknown
1Other
2Results
3Subtests
4Actions
5Warnings
6Status
7Device Errors
8Service Errors
9Setting Data
10Statistics
11Hardware Configuration
12Software Configuration
13References
14Debug
Property OtherRecordTypeDescription Qualifiers
NameTypeValueFrom Class
DescriptionstringWhen " Other " (value=1) is entered in the RecordType property, OtherRecordTypeDescription can be used to describe the message type. CIM_DiagnosticRecord
ModelCorrespondencestringCIM_DiagnosticSettingData.OtherLogOptionsDescriptions
CIM_DiagnosticRecord.RecordType
CIM_DiagnosticRecord

Property CreationTimeStamp Qualifiers
NameTypeValueFrom Class
DescriptionstringA timestamp indicating when the record was created. CIM_DiagnosticRecord

Property RecordFormat Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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
ModelCorrespondencestringCIM_RecordForLog.RecordData CIM_RecordForLog

Property RecordData Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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
ModelCorrespondencestringCIM_RecordForLog.RecordFormat CIM_RecordForLog

Property Locale Qualifiers
NameTypeValueFrom Class
DescriptionstringThis 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
NameTypeValueFrom Class
DescriptionstringThe Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement
MaxLenuint3264 CIM_ManagedElement

Property Description Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Description property provides a textual description of the object. CIM_ManagedElement

Property ElementName Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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

Methods

Method Qualifiers

Parameters

Parameter Qualifiers

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_CorrespondingSettingDataRecordCIM_DiagnosticRecordDataRecord
CIM_CorrespondingSettingsRecordCIM_DiagnosticRecordDataRecord
CIM_RecordAppliesToElementCIM_RecordForLogAntecedent
CIM_LogManagesRecordCIM_RecordForLogRecord
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_CredentialContextCIM_ManagedElementElementProvidingContext
CIM_DefaultElementCapabilitiesCIM_ManagedElementManagedElement
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_RelatedElementCausingErrorCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementDependent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_IsSpareCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SWRManageableAspectCIM_ManagedElementSystemElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_OwningCollectionElementCIM_ManagedElementOwningElement
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement
CIM_AuthorizationRuleAppliesToTargetCIM_ManagedElementManagedElement
CIM_RoleLimitedToTargetCIM_ManagedElementTargetElement
CIM_StatisticsCIM_ManagedElementElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ManagementSAPCIM_ManagedElementManagedElement