Class CIM_DiagnosticSetting
extends CIM_Setting

Specific diagnostic test parameters and execution instructions are defined by subclassing and/or instantiating the DiagnosticSetting object. To provide more detailed Settings for a type of test (i.e., additional properties), subclassing is appropriate. When only the generic Setting information is required, instantiation of the Diagnostic Setting class may suffice. Data from DiagnosticSetting is captured in DiagnosticResult. When RunTest starts execution the settings, which are time sensitive, should be evaluated and captured. This is suggested since the DiagnosticSetting object can be modified at any time, and therefore the current test settings could be lost.

Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_Setting
   |
   +--CIM_DiagnosticSetting

Direct Known Subclasses

None.

Class Qualifiers

NameData TypeValueScopeFlavors
DescriptionstringSpecific diagnostic test parameters and execution instructions are defined by subclassing and/or instantiating the DiagnosticSetting object. To provide more detailed Settings for a type of test (i.e., additional properties), subclassing is appropriate. When only the generic Setting information is required, instantiation of the Diagnostic Setting class may suffice. Data from DiagnosticSetting is captured in DiagnosticResult. When RunTest starts execution the settings, which are time sensitive, should be evaluated and captured. This is suggested since the DiagnosticSetting object can be modified at any time, and therefore the current test settings could be lost.None TRANSLATABLE= true
Versionstring2.7.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
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
HaltOnErrorboolean
DescriptionstringWhen this flag is true, the test will halt after finding the first error.None TRANSLATABLE= true
WritebooleantrueNone None
OtherLoopControlDescriptionstring
DescriptionstringProvides additional information for LoopControl when its value is set to 1 ('Other').None TRANSLATABLE= true
ModelCorrespondencestringCIM_DiagnosticSetting.LoopControlParameterNone None
WritebooleantrueNone None
PercentOfTestCoverageuint8
DescriptionstringRequests the diagnostic software to reduce test coverage to the specified percentage. For example, a hard drive scan test could be asked to run at 50%. The most effective way to accomplish this is for the test software to scan every other track, as opposed to only scanning the first half of a drive. It is assumed that the effectiveness of the test is impacted proportional to the percentage of testing requested. Permissible values for this property range from 0 to 100. This property may not be applicable to all tests. If it can be set for a test, the value 7 ("Supports PercentOf TestCoverage") should be entered into the DiagnosticTest's Characteristics array.None TRANSLATABLE= true
MaxValuesint64100None None
MinValuesint640None None
ModelCorrespondencestringCIM_DiagnosticTest.CharacteristicsNone None
UnitsstringPercentNone TRANSLATABLE= true
WritebooleantrueNone None
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
WritebooleantrueNone None
ReportSoftErrorsboolean
DescriptionstringWhen this flag is true, the diagnostic test will report 'soft errors'. In this context, a soft error is a message from the diagnostic reporting a known defect in the hardware or driver configuration, or execution environment. Examples are: 'Not enough memory', 'Driver IOCTL not implemented', 'Video RAM compare failed during polygon fill test (A known defect in the video chipset)', etc.None TRANSLATABLE= true
WritebooleantrueNone None
ReportStatusMessagesboolean
DescriptionstringWhen this flag is true, the diagnostic test will report 'status messages'. In this context, a status message indicates that the diagnostic code is at a checkpoint. Examples are: "Completion of phase 1", "Complex pattern", etc.None TRANSLATABLE= true
WritebooleantrueNone None
ResultPersistenceuint32
DescriptionstringThe ResultPersistence property is a directive from a diagnostic client to a diagnostic provider. It allows the client to specify to the diagnostic service provider how long to persist the messages that result from execution of a diagnostic service. This applies to instances of DiagnosticResult. The timeout period starts upon completion of the diagnostic action described by the DiagnosticTest. 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
UnitsstringSecondsNone TRANSLATABLE= true
WritebooleantrueNone None
SettingIDstring
DescriptionstringThe identifier by which the DiagnosticSetting object is known and uniquely named. One possible naming scheme is to name the SettingID using the DiagnosticTest's CreationClass Name and DiagnosticName, plus a GUID (Globally Unique IDentifier). Note that at an enterprise level, there is typically not a one to one mapping between a DiagnosticSetting and all copies of the DiagnosticTest. The proposed naming convention will scale to the entrprise level.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
OverridestringSettingIDNone OVERRIDABLE= false
TestWarningLeveluint16
DescriptionstringSets the level of warning messages to be logged. If for example no warning information is required, the level would be set to "No Warnings" (value=0). Using "Missing Resources" (value=1) will cause warnings to be generated when required resources or hardware are not found. Setting the value to 2, "Testing Impacts", results in both missing resources and 'test impact' warnings (for example, multiple retries required) to be reported.None TRANSLATABLE= true
ValueMapstring0, 1, 2, 3None None
ValuesstringNo Warnings, Missing Resources, Testing Impacts, All WarningsNone TRANSLATABLE= true
WritebooleantrueNone None
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. The descriptions for each loop control are given below: Unknown/Default (= 0) Other (= 1) : Additional detail may be found in OtherLoopControlDescription. Continuous (= 2) : The corresponding LoopControl Parameter is ignored and the test will execute continuously. Tests that use this control should also support DiscontinueTest. Count(=3): The corresponding LoopControlParameter is interpreted as a loop count (uint32), indicating the number of times the test should be repeated with a single invocation of RunTest by a CIM client. Timer (= 4) : The corresponding LoopControlParameter is interpreted as an initial value (uint32) for a test loop timer, given in seconds. The looping is terminated when this timer has lapsed. ErrorCount (= 5) : The corresponding LoopControl Parameter is interpreted as an error count (uint32). The loop will continue until the number of errors that have occurred exceeds the ErrorCount. Note: the ErrorCount only refers to hard test errors; it does not include soft errors or warnings.None TRANSLATABLE= true
ModelCorrespondencestringCIM_DiagnosticSetting.LoopControlParameter, CIM_DiagnosticSetting.OtherLoopControlDescriptionNone None
ValueMapstring0, 1, 2, 3, 4, 5None None
ValuesstringUnknown/Default, Other, Continuous, Count, Timer, Error CountNone TRANSLATABLE= true
WritebooleantrueNone None
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_DiagnosticSetting.LoopControlNone None
WritebooleantrueNone None