CIM211 Class Declaration
CIM_DiagnosticSettingData

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

Class Hierarchy

CIM_DiagnosticSettingData --> CIM_SettingData --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_SettingData
NAMECIM_DiagnosticSettingData

Class Qualifiers

Class CIM_DiagnosticSettingData Qualifiers
NameTypeValueFrom Class
Experimentalbooleantrue CIM_DiagnosticSettingData
Versionstring2.11.0 CIM_DiagnosticSettingData
DescriptionstringSpecific diagnostic test parameters and execution instructions are defined by this class. To provide more detailed Settings for a type of test (i.e., additional properties), subclassing is appropriate. CIM_DiagnosticSettingData
DescriptionstringThe SettingData class represents configuration-related and operational parameters for one or more ManagedElements. A ManagedElement can have multiple SettingData objects associated with it. The current operational values for the parameters of the element are reflected by properties in the Element itself or by properties in its associations. These properties do not have to be the same values that are present in the SettingData object. For example, a modem might have a SettingData baud rate of 56Kb/sec but be operating at 19.2Kb/sec. Note: The CIM_SettingData class is very similar to CIM_Setting, yet both classes are present in the model because many implementations have successfully used CIM_Setting. However, issues have arisen that could not be resolved without defining a new class. Therefore, until a new major release occurs, both classes will exist in the model. Refer to the Core White Paper for additional information. SettingData instances can be aggregated together into higher- level SettingData objects using ConcreteComponent associations. CIM_SettingData
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
HaltOnErrorboolean Description CIM_DiagnosticSettingData
QuickModeboolean Description CIM_DiagnosticSettingData
PercentOfTestCoverageuint8 Description
Units
MinValue
MaxValue
ModelCorrespondence
CIM_DiagnosticSettingData
LoopControlParameterstring[] Description
ArrayType
ModelCorrespondence
CIM_DiagnosticSettingData
LoopControluint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_DiagnosticSettingData
OtherLoopControlDescriptionsstring[] Description
ArrayType
ModelCorrespondence
CIM_DiagnosticSettingData
ResultPersistenceuint32 Description
Units
CIM_DiagnosticSettingData
LogOptionsuint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_DiagnosticSettingData
OtherLogOptionsDescriptionsstring[] Description
ModelCorrespondence
CIM_DiagnosticSettingData
LogStorageuint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_DiagnosticSettingData
OtherLogStorageDescriptionsstring[] Description
ArrayType
ModelCorrespondence
CIM_DiagnosticSettingData
VerbosityLeveluint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_DiagnosticSettingData
InstanceIDstring Key
Description
CIM_SettingData
ElementNamestring Required
Override
Description
CIM_SettingData
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement

Property Qualifiers

Property HaltOnError Qualifiers
NameTypeValueFrom Class
DescriptionstringWhen this flag is true, the test will halt after finding the first error. CIM_DiagnosticSettingData

Property QuickMode Qualifiers
NameTypeValueFrom Class
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. CIM_DiagnosticSettingData

Property PercentOfTestCoverage Qualifiers
NameTypeValueFrom Class
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. CIM_DiagnosticSettingData
UnitsstringPercent CIM_DiagnosticSettingData
MinValuesint640 CIM_DiagnosticSettingData
MaxValuesint64100 CIM_DiagnosticSettingData
ModelCorrespondencestringCIM_DiagnosticServiceCapabilities.SupportedServiceModes CIM_DiagnosticSettingData

Property LoopControlParameter Qualifiers
NameTypeValueFrom Class
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 a test method by a CIM client. CIM_DiagnosticSettingData
ArrayTypestringIndexed CIM_DiagnosticSettingData
ModelCorrespondencestringCIM_DiagnosticSettingData.LoopControl CIM_DiagnosticSettingData

Property LoopControl Qualifiers
NameTypeValueFrom Class
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 a test method 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 (= 0) Other (= 1) : Additional detail may be found in OtherLoopControlDescriptions. 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 a test method 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. CIM_DiagnosticSettingData
ValueMapstring
[See below.]
CIM_DiagnosticSettingData
ValuesstringUnknown
Other
Continuous
Count
Timer
ErrorCount
CIM_DiagnosticSettingData
ArrayTypestringIndexed CIM_DiagnosticSettingData
ModelCorrespondencestringCIM_DiagnosticSettingData.LoopControlParameter
CIM_DiagnosticSettingData.OtherLoopControlDescriptions
CIM_DiagnosticServiceCapabilities.SupportedLoopControl
CIM_DiagnosticSettingData

NameValue
0Unknown
1Other
2Continuous
3Count
4Timer
5ErrorCount
Property OtherLoopControlDescriptions Qualifiers
NameTypeValueFrom Class
DescriptionstringThis property provides additional information for LoopControl when the corresponding value is set to 1 ( ’ Other ’ ). CIM_DiagnosticSettingData
ArrayTypestringIndexed CIM_DiagnosticSettingData
ModelCorrespondencestringCIM_DiagnosticSettingData.LoopControlParameter
CIM_DiagnosticSettingData.LoopControl
CIM_DiagnosticSettingData

Property ResultPersistence Qualifiers
NameTypeValueFrom Class
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 as well as the preferred use of DiagnosticServiceRecord. The timeout period starts upon completion of the diagnostic action described by the DiagnosticService. 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. CIM_DiagnosticSettingData
UnitsstringSeconds CIM_DiagnosticSettingData

Property LogOptions Qualifiers
NameTypeValueFrom Class
DescriptionstringThe LogOptions property is used to specify the types of data that SHOULD be logged by the diagnostic service. Any number of values may be specified in the array. Note that the default behavior is for nothing to be logged. The AMOUNT of data to be logged can be controlled for each value selected by specifying a VerbosityLevel value. Verbosity may not apply to all LogOptions values, in which case the default VerbosityLevel of " Standard " SHOULD be used. The RecordForLog produced by running a service MUST be tagged with a RecordType that corresponds to one of these log option values. Following is a brief description of the available log options: * " Other " (value = 1): Details are given in the corresponding OtherLogOptionsDescriptions entry. * " Results " (value = 2): Log the results obtained by running the service. This is the most common value for reporting the service results. * " Subtests " (value = 3): Log a test summary report upon completion of each subtest and each loop iteration. The summary reports SHOULD state whether the individual subtest or iteration passed or failed and list relevant error codes and respective error counts. * " Actions " (value = 4): Log corrective action and instructional messages to guide service personnel; for example, a prioritized list of actions to perform in order to isolate a failure or correct a problem. When ordering steps or prioritizing actions, a number should proceed the text; for example, 1) Do this first, 2) Do this next, etc. * " Warnings " (value = 5): Log warning messages; for example, ’ device will be taken off line ’ , ’ test is long-running ’ or ’ available memory is low ’ . The VerbosityLevel value specified for the Warnings option is related to the severity of the warnings logged; for instance, one would specify a high level of verbosity to get all warnings logged, regardless of severity, and a low level of verbosity to have only the most severe warnings logged. * " Status " (value = 6): Log status messages; for example, state information for the driver, device, or system. * " Device Errors " (value = 7): Log errors related to the managed element being serviced. * " Service Errors " (value = 8): Log errors related to the service itself rather than the element being serviced, such as ’ Resource Allocaton Failure ’ . * " Setting Data " (value=9): Log the property values of the DiagnosticSettingData object used to configure the service. * " Statistics " (value = 10): Log statistical messages; for example, packets sent per second. * " Hardware Configuration " (value = 11): Log messages that contain information about the hardware configuration as viewed by the service; for example, vendor, version, FRU identification, and location information. The format and contents of this property is element dependent. Examples are: SCSI ID, LPTx, PCI Slot Number, and Dimm#. * " Software Configuration " (value = 12): Log messages that contain information about the software environment as viewed by the service; for example, the name and version of all the critical software elements controlling the device under test. Each configuration message SHOULD have the following common format: Element name; element type; manufacturer name; version; for example, ’ Miniport driver; SCSI; Intel; Version 1.2 ’ . * " Reference " (value = 13): Log the keys of an CIM object of of interest; for example, the element under test, or a data file. * " Debug " (value = 14): Log debug messages. These messages are vendor specific. CIM_DiagnosticSettingData
ValueMapstring
[See below.]
CIM_DiagnosticSettingData
ValuesstringUnknown
Other
Results
Subtests
Actions
Warnings
Status
Device Errors
Service Errors
Setting Data
Statistics
Hardware Configuration
Software Configuration
References
Debug
No Log Options
CIM_DiagnosticSettingData
ArrayTypestringIndexed CIM_DiagnosticSettingData
ModelCorrespondencestringCIM_DiagnosticSettingData.OtherLogOptionsDescriptions
CIM_DiagnosticServiceCapabilities.SupportedLogOptions
CIM_DiagnosticServiceRecord.RecordType
CIM_DiagnosticSettingData.VerbosityLevel
CIM_DiagnosticSettingData

NameValue
0Unknown
1Other
2Results
3Subtests
4Actions
5Warnings
6Status
7Device Errors
8Service Errors
9Setting Data
10Statistics
11Hardware Configuration
12Software Configuration
13References
14Debug
0x8000No Log Options
Property OtherLogOptionsDescriptions Qualifiers
NameTypeValueFrom Class
DescriptionstringProvides additional information regarding the types of test messages that are logged when the property LogOptions includes the value 1 ( " Other " ). CIM_DiagnosticSettingData
ModelCorrespondencestringCIM_DiagnosticSettingData.LogOptions CIM_DiagnosticSettingData

Property LogStorage Qualifiers
NameTypeValueFrom Class
DescriptionstringThe LogStorage setting property indicates which types of supported storage should be used by the Diagnostic Service for logging of the data specified in LogOptions. The values are: " DiagnosticLog " (Value = 2): Use the DiagnosticLog and DiagnosticRecord classes. " MessageLog " (Value = 3): Use the MessageLog class and its methods. " File " (Value = 4): Write data to a file. CIM_DiagnosticSettingData
ValueMapstring
[See below.]
CIM_DiagnosticSettingData
ValuesstringUnknown
Other
DiagnosticLog
MessageLog
File
CIM_DiagnosticSettingData
ArrayTypestringIndexed CIM_DiagnosticSettingData
ModelCorrespondencestringCIM_DiagnosticSettingData.OtherLogStorageDescriptions
CIM_DiagnosticServiceCapabilities.SupportedLogStorage
CIM_DiagnosticSettingData

NameValue
0Unknown
1Other
2DiagnosticLog
3MessageLog
4File
Property OtherLogStorageDescriptions Qualifiers
NameTypeValueFrom Class
DescriptionstringThis property provides additional information for LogStorage when the corresponding value is set to 1 ( " Other " ). CIM_DiagnosticSettingData
ArrayTypestringIndexed CIM_DiagnosticSettingData
ModelCorrespondencestringCIM_DiagnosticSettingData.LogStorage CIM_DiagnosticSettingData

Property VerbosityLevel Qualifiers
NameTypeValueFrom Class
DescriptionstringA client may want to specify the desired volume or detail logged by a diagnostic service. This property 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. Note that VerbosityLevel is a subjective property and relates to the degree of detail, not an absolute metric. A client simply specifies its desired level of detail and the provider publishes its data in accordance with this desired level of detail. Verbosity may not apply to all LogOptions values, in which case the default VerbosityLevel of " Standard " SHOULD be used. CIM_DiagnosticSettingData
ValueMapstring
[See below.]
CIM_DiagnosticSettingData
ValuesstringMinimum
Standard
Full
CIM_DiagnosticSettingData
ArrayTypestringIndexed CIM_DiagnosticSettingData
ModelCorrespondencestringCIM_DiagnosticSettingData.LogOptions CIM_DiagnosticSettingData

NameValue
2Minimum
3Standard
4Full
Property InstanceID Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_SettingData
DescriptionstringWithin the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. 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 that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement 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 reused to identify different underlying (real-world) elements. If the above " preferred " algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. For DMTF-defined instances, the " preferred " algorithm must be used with the < OrgID > set to CIM. CIM_SettingData

Property ElementName Qualifiers
NameTypeValueFrom Class
Requiredbooleantrue CIM_SettingData
OverridestringElementName CIM_SettingData
DescriptionstringThe user-friendly name for this instance of SettingData. In addition, the user-friendly name can be used as an index property for a search or query. (Note: The name does not have to be unique within a namespace.) CIM_SettingData

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_SettingAssociatedToCapabilitiesCIM_SettingDataDependent
CIM_ElementSettingDataCIM_SettingDataSettingData
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