Class CIM_DiagnosticSettingRecord
extends CIM_DiagnosticRecord

The DiagnosticSettingData that was used to when a Diagnostic was run.

Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_RecordForLog
   |
   +--CIM_DiagnosticRecord
   |
   +--CIM_DiagnosticSettingRecord

Direct Known Subclasses

None.

Class Qualifiers

NameData TypeValueScopeFlavors
DescriptionstringThe DiagnosticSettingData that was used to when a Diagnostic was run.None TRANSLATABLE= true
Versionstring2.9.0TOSUBCLASS= falseTRANSLATABLE= true

Local Class Properties

NameData TypeQualifiers
NameData TypeValueScopeFlavors
Captionstring
DescriptionstringThe Caption property is a short textual description (one- line string) of the object.None TRANSLATABLE= true
MaxLenuint3264None None
CreationTimeStampdatetime
DescriptionstringA timestamp indicating when the record was created.None TRANSLATABLE= true
Descriptionstring
DescriptionstringThe Description property provides a textual description of the object.None TRANSLATABLE= true
ElementNamestring
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 ManagedSystemElement's Name property 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 MAY be present in both the Name and ElementName properties.None TRANSLATABLE= true
ExpirationDatedatetime
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 DiagnosticSetting class. If a ResultPersistence value is not provided, the ExpirationDate should be set to the current datetime. Once the date has expired, instances should be deleted as soon as possible.None TRANSLATABLE= true
ModelCorrespondencestringCIM_DiagnosticSetting.ResultPersistenceNone None
RequiredbooleantrueNone OVERRIDABLE= false
HaltOnErrorboolean
DescriptionstringWhen this flag is true, the test will halt after finding the first error.None TRANSLATABLE= true
InstanceIDstring
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'.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
Localestring
DescriptionstringA 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
ManagedElementNamestring
DescriptionstringThis property SHOULD reflect the value of the underlying ManagedElement.ElementName property.None TRANSLATABLE= true
ModelCorrespondencestringCIM_ManagedElement.ElementNameNone None
RequiredbooleantrueNone OVERRIDABLE= false
OtherRecordTypeDescriptionstring
DescriptionstringWhen "Other" (value=1) is entered in the RecordType property, OtherRecordTypeDescription can be used to describe the message type.None TRANSLATABLE= true
ModelCorrespondencestringCIM_DiagnosticSetting.OtherLogOptionsDescriptions, CIM_DiagnosticRecord.RecordTypeNone None
PercentOfTestCoverageuint8
DescriptionstringThe requested percentage of coverage for the diagnostic service. For example, a hard drive scan test could be asked to run at 50%. Permissible values for this property range from 0 to 100.None TRANSLATABLE= true
MaxValuesint64100None None
MinValuesint640None None
ModelCorrespondencestringCIM_DiagnosticSetting.PercentOfTestCoverageNone None
UnitsstringPercentNone TRANSLATABLE= true
QuickModeboolean
DescriptionstringWhen this flag is true, the test software should attempt to run in an accelerated fashion either by reducing the coverage or number of tests performed.None TRANSLATABLE= true
RecordDatastring
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.None TRANSLATABLE= true
ModelCorrespondencestringCIM_RecordForLog.RecordFormatNone None
RecordFormatstring
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".None TRANSLATABLE= true
ModelCorrespondencestringCIM_RecordForLog.RecordDataNone None
RecordTypeuint16
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 DiagnosticSetting.LogOptions property. A brief summary of the various log options can be found in CIM_DiagnosticSetting.LogOptions.None TRANSLATABLE= true
ModelCorrespondencestringCIM_DiagnosticSetting.LogOptions, CIM_DiagnosticRecord.OtherRecordTypeDescriptionNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14None None
ValuesstringUnknown, Other, Results, Subtests, Actions, Warnings, Status, Device Errors, Service Errors, Setting Data, Statistics, Hardware Configuration, Software Configuration, References, DebugNone TRANSLATABLE= true
ResultPersistenceuint32
DescriptionstringThe desired length of time to persist the messages that result from execution of a diagnostic service. Here is a summary of the choices and behaviors for different ResultPersistence values: 0 = "No Persistence": Setting the timer to zero tells the provider not to persist the diagnostic result. The diagnostic information is only available while the diagnostic is executing or at its conclusion. Value > 0 and < 0xFFFFFFFF = "Persist With TimeOut": Setting the ResultPersistenceOption to a integer will cause the DiagnosticResult to be persisted for that number of seconds. At the end of that time, the DiagnosticResult may be deleted by the diagnostic service provider. 0xFFFFFFFF = "Persist Forever": By setting the timeout value to the very large value, 0xFFFFFFFF, the provider shall persist results forever. In this case, the client MUST bear the responsibility for deleting them.None TRANSLATABLE= true
ModelCorrespondencestringCIM_DiagnosticSetting.ResultPersistenceNone None
UnitsstringSecondsNone TRANSLATABLE= true
ServiceNamestring
DescriptionstringThis property should reflect the value of the underlying DiagnosticService.Name property.None TRANSLATABLE= true
ModelCorrespondencestringCIM_DiagnosticService.NameNone None
RequiredbooleantrueNone OVERRIDABLE= false
LogOptionsuint16[]
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringThe LogOptions property lists the log options that were requested for the Diagnostic Service. A brief summary of the various log options can be found in CIM_DiagnosticSetting.LogOptions.None TRANSLATABLE= true
ModelCorrespondencestringCIM_DiagnosticSettingRecord.OtherLogOptionsDescriptions, CIM_DiagnosticSetting.LogOptionsNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14None None
ValuesstringUnknown, Other, Results, Subtests, Actions, Warnings, Status, Device Errors, Service Errors, Setting Data, Statistics, Hardware Configuration, Software Configuration, References, DebugNone TRANSLATABLE= true
LoopControluint16[]
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringLoopControl, used in conjunction with LoopControlParameter, sets one or more loop control mechanisms that limits the number of times a test should be repeated with a single invocation of RunTest by a CIM client. There is an array-positional correspondence between LoopControl entries & LoopControlParameter entries. The entries in these coupled arrays of loop controls can be used in a logical OR fashion to achieve the desired loop control. For example, if a client wants to loop a test 1000 times, but quit if a timer runs out, it could set both controls into the LoopControl array as two separate entries in each array. The looping test will terminate when the first of the two ORed conditions are met. A brief description for each loop control can be found in the description of DiagnosticSetting.LoopControl.None TRANSLATABLE= true
ModelCorrespondencestringCIM_DiagnosticSetting.LoopControlParameter, CIM_DiagnosticSettingRecord.OtherLoopControlDescriptionsNone None
ValueMapstring0, 1, 2, 3, 4, 5None None
ValuesstringUnknown, Other, Continuous, Count, Timer, Error CountNone TRANSLATABLE= true
LoopControlParameterstring[]
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringArray entries contain parameters corresponding to entries in the LoopControl array, limiting the number of times a test should be repeated with a single invocation of RunTest by a CIM client.None TRANSLATABLE= true
ModelCorrespondencestringCIM_DiagnosticSettingRecord.LoopControl, CIM_DiagnosticSetting.LoopControlParameterNone None
OtherLogOptionsDescriptionsstring[]
DescriptionstringProvides additional information regarding the types of test messages that are logged when the property LogOptions includes the value 1 ("Other").None TRANSLATABLE= true
ModelCorrespondencestringCIM_DiagnosticSettingRecord.LogOptions, CIM_DiagnosticSetting.OtherLogOptionsDescriptionsNone None
OtherLoopControlDescriptionsstring[]
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringProvides additional information for LoopControl when its value is set to 1 ('Other').None TRANSLATABLE= true
ModelCorrespondencestringCIM_DiagnosticSetting.OtherLoopControlDescriptions, CIM_DiagnosticSettingRecord.LoopControlNone None
VerbosityLeveluint16[]
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringA client may want to specify the volume or detail of information logged by a diagnostic service. This metric is applied to a corresponding logging option, acting as a qualifier on its description. Three levels of verbosity are defined as follows: * "Minimum" (value=2): Specified if the least amount of information is desired; for example, Pass or Fail. * "Standard" (value=3): This is the standard level of messaging provided by the service. It is the form most likely to be used if no verbosity value is specified (default). * "Full" (value=4): Specified when all information, regardless of size, is desired. Verbosity may not apply to all LogOptions values, in which case the default VerbosityLevel of "Standard" SHOULD be used.None TRANSLATABLE= true
ModelCorrespondencestringCIM_DiagnosticSetting.LogOptionsNone None
ValueMapstring2, 3, 4None None
ValuesstringMinimum, Standard, FullNone TRANSLATABLE= true