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 |
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 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 |
HaltOnError | boolean |
Description | string | When this flag is true, the test will halt after finding the first error. | None | TRANSLATABLE= true |
Write | boolean | true | None | None |
OtherLoopControlDescription | string |
Description | string | Provides additional information for LoopControl when its value is set to 1 ('Other'). | None | TRANSLATABLE= true |
ModelCorrespondence | string | CIM_DiagnosticSetting.LoopControlParameter | None | None |
Write | boolean | true | None | None |
PercentOfTestCoverage | uint8 |
Description | string | Requests 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 |
MaxValue | sint64 | 100 | None | None |
MinValue | sint64 | 0 | None | None |
ModelCorrespondence | string | CIM_DiagnosticTest.Characteristics | None | None |
Units | string | Percent | None | TRANSLATABLE= true |
Write | boolean | true | None | None |
QuickMode | boolean |
Description | string | When 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 |
Write | boolean | true | None | None |
ReportSoftErrors | boolean |
Description | string | When 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 |
Write | boolean | true | None | None |
ReportStatusMessages | boolean |
Description | string | When 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 |
Write | boolean | true | None | None |
ResultPersistence | uint32 |
Description | string | The 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 |
Units | string | Seconds | None | TRANSLATABLE= true |
Write | boolean | true | None | None |
SettingID | string |
Description | string | The 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 |
Key | boolean | true | None | OVERRIDABLE= false
|
MaxLen | uint32 | 256 | None | None |
Override | string | SettingID | None | OVERRIDABLE= false
|
TestWarningLevel | uint16 |
Description | string | Sets 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 |
ValueMap | string | 0, 1, 2, 3 | None | None |
Values | string | No Warnings, Missing Resources, Testing Impacts, All Warnings | None | TRANSLATABLE= true |
Write | boolean | true | None | None |
LoopControl | uint16[] |
ArrayType | string | Indexed | None | OVERRIDABLE= false
|
Description | string | LoopControl, 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 |
ModelCorrespondence | string | CIM_DiagnosticSetting.LoopControlParameter, CIM_DiagnosticSetting.OtherLoopControlDescription | None | None |
ValueMap | string | 0, 1, 2, 3, 4, 5 | None | None |
Values | string | Unknown/Default, Other, Continuous, Count, Timer, Error Count | None | TRANSLATABLE= true |
Write | boolean | true | None | None |
LoopControlParameter | string[] |
ArrayType | string | Indexed | None | OVERRIDABLE= false
|
Description | string | Array 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 |
ModelCorrespondence | string | CIM_DiagnosticSetting.LoopControl | None | None |
Write | boolean | true | None | None |