CIM211 Class Declaration
CIM_DiagnosticSetting

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

Class Hierarchy

CIM_DiagnosticSetting --> CIM_Setting --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_Setting
NAMECIM_DiagnosticSetting

Class Qualifiers

Class CIM_DiagnosticSetting Qualifiers
NameTypeValueFrom Class
DeprecatedstringCIM_DiagnosticSettingData CIM_DiagnosticSetting
Versionstring2.11.0 CIM_DiagnosticSetting
DescriptionstringDiagnosticSetting is being deprecated and replaced by an identical class that derives from CIM_SettingData. CIM_Setting is to be replaced by CIM_SettingData in future versions of CIM. Specific 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_DiagnosticSetting
DescriptionstringThe Setting class represents configuration-related and operational parameters for one or more ManagedSystemElements. An Element can have multiple Setting objects associated with it. The current operational values for the parameters of an 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 present in the Setting object. For example, a modem might have a Setting 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. Setting instances can be aggregated together into higher-level Setting objects using ConcreteComponent associations. CIM_Setting
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
SettingIDstring Deprecated
Key
Override
Description
MaxLen
CIM_DiagnosticSetting
TestWarningLeveluint16 Deprecated
Write
Description
ValueMap
Values
CIM_DiagnosticSetting
ReportSoftErrorsboolean Deprecated
Write
Description
CIM_DiagnosticSetting
ReportStatusMessagesboolean Deprecated
Write
Description
CIM_DiagnosticSetting
HaltOnErrorboolean Deprecated
Write
Description
CIM_DiagnosticSetting
QuickModeboolean Deprecated
Write
Description
CIM_DiagnosticSetting
PercentOfTestCoverageuint8 Deprecated
Write
Description
Units
MinValue
MaxValue
ModelCorrespondence
CIM_DiagnosticSetting
LoopControlParameterstring[] Deprecated
Write
Description
ArrayType
ModelCorrespondence
CIM_DiagnosticSetting
LoopControluint16[] Deprecated
Write
Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_DiagnosticSetting
OtherLoopControlDescriptionstring Deprecated
Write
Description
ModelCorrespondence
CIM_DiagnosticSetting
OtherLoopControlDescriptionsstring[] Deprecated
Write
Description
ArrayType
ModelCorrespondence
CIM_DiagnosticSetting
ResultPersistenceuint32 Deprecated
Write
Description
Units
CIM_DiagnosticSetting
LogOptionsuint16[] Deprecated
Write
Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_DiagnosticSetting
OtherLogOptionsDescriptionsstring[] Deprecated
Write
Description
ModelCorrespondence
CIM_DiagnosticSetting
LogStorageuint16[] Deprecated
Write
Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_DiagnosticSetting
OtherLogStorageDescriptionsstring[] Deprecated
Write
Description
ArrayType
ModelCorrespondence
CIM_DiagnosticSetting
VerbosityLeveluint16[] Deprecated
Write
Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_DiagnosticSetting
Localesstring[] Deprecated
Write
Description
ModelCorrespondence
CIM_DiagnosticSetting
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement
ElementNamestring Description CIM_ManagedElement

Property Qualifiers

Property SettingID Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_DiagnosticSetting
OverridestringSettingID CIM_DiagnosticSetting
DescriptionstringIn order to ensure uniqueness within the NameSpace, the value of SettingID 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 SettingID, 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 SettingID 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 SettingID is not re-used across any SettingIDs produced by this or other providers for this instance ’ s NameSpace. A preferred value for < LocalID > is a timestamp (CIM DateTime). For example, ACME:19980525133015.0000000-300. CIM_DiagnosticSetting
MaxLenuint32256 CIM_DiagnosticSetting

Property TestWarningLevel Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_DiagnosticSetting
DescriptionstringThis property is being deprecated because the TestWarningLevel and LogOptions properties serve the same purpose. It is deprecated in lieu of using the LogOptions ( ’ Warnings ’ ) property in conjunction with VerbosityLevel to specify this information. The ’ Missing Resources ’ and ’ Testing Impacts ’ values are not included directly in LogOptions, but they are expected to be recorded in the resulting DiagnosticServiceRecord object. 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. CIM_DiagnosticSetting
ValueMapstring
[See below.]
CIM_DiagnosticSetting
ValuesstringNo Warnings
Missing Resources
Testing Impacts
All Warnings
CIM_DiagnosticSetting

NameValue
0No Warnings
1Missing Resources
2Testing Impacts
3All Warnings
Property ReportSoftErrors Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_DiagnosticSetting
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. CIM_DiagnosticSetting

Property ReportStatusMessages Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_DiagnosticSetting
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. CIM_DiagnosticSetting

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

Property QuickMode Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_DiagnosticSetting
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_DiagnosticSetting

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

Property LoopControlParameter Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_DiagnosticSetting
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_DiagnosticSetting
ArrayTypestringIndexed CIM_DiagnosticSetting
ModelCorrespondencestringCIM_DiagnosticSetting.LoopControl CIM_DiagnosticSetting

Property LoopControl Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_DiagnosticSetting
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_DiagnosticSetting
ValueMapstring
[See below.]
CIM_DiagnosticSetting
ValuesstringUnknown
Other
Continuous
Count
Timer
ErrorCount
CIM_DiagnosticSetting
ArrayTypestringIndexed CIM_DiagnosticSetting
ModelCorrespondencestringCIM_DiagnosticSetting.LoopControlParameter
CIM_DiagnosticSetting.OtherLoopControlDescriptions
CIM_DiagnosticServiceCapabilities.SupportedLoopControl
CIM_DiagnosticSetting

NameValue
0Unknown
1Other
2Continuous
3Count
4Timer
5ErrorCount
Property OtherLoopControlDescription Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_DiagnosticSetting
DescriptionstringThis property is deprecated and replaced with an array. It provides additional information for LoopControl when its value is set to 1 ( ’ Other ’ ). CIM_DiagnosticSetting
ModelCorrespondencestringCIM_DiagnosticSetting.LoopControlParameter CIM_DiagnosticSetting

Property OtherLoopControlDescriptions Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_DiagnosticSetting
DescriptionstringThis property provides additional information for LoopControl when the corresponding value is set to 1 ( ’ Other ’ ). CIM_DiagnosticSetting
ArrayTypestringIndexed CIM_DiagnosticSetting
ModelCorrespondencestringCIM_DiagnosticSetting.LoopControlParameter
CIM_DiagnosticSetting.LoopControl
CIM_DiagnosticSetting

Property ResultPersistence Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_DiagnosticSetting
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_DiagnosticSetting
UnitsstringSeconds CIM_DiagnosticSetting

Property LogOptions Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_DiagnosticSetting
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 DiagnosticSetting 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_DiagnosticSetting
ValueMapstring
[See below.]
CIM_DiagnosticSetting
ValuesstringUnknown
Other
Results
Subtests
Actions
Warnings
Status
Device Errors
Service Errors
Setting Data
Statistics
Hardware Configuration
Software Configuration
References
Debug
No Log Options
CIM_DiagnosticSetting
ArrayTypestringIndexed CIM_DiagnosticSetting
ModelCorrespondencestringCIM_DiagnosticSetting.OtherLogOptionsDescriptions
CIM_DiagnosticServiceCapabilities.SupportedLogOptions
CIM_DiagnosticServiceRecord.RecordType
CIM_DiagnosticSetting.VerbosityLevel
CIM_DiagnosticSetting

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
Writebooleantrue CIM_DiagnosticSetting
DescriptionstringProvides additional information regarding the types of test messages that are logged when the property LogOptions includes the value 1 ( " Other " ). CIM_DiagnosticSetting
ModelCorrespondencestringCIM_DiagnosticSetting.LogOptions CIM_DiagnosticSetting

Property LogStorage Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_DiagnosticSetting
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_DiagnosticSetting
ValueMapstring
[See below.]
CIM_DiagnosticSetting
ValuesstringUnknown
Other
DiagnosticLog
MessageLog
File
CIM_DiagnosticSetting
ArrayTypestringIndexed CIM_DiagnosticSetting
ModelCorrespondencestringCIM_DiagnosticSetting.OtherLogStorageDescriptions
CIM_DiagnosticServiceCapabilities.SupportedLogStorage
CIM_DiagnosticSetting

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

Property VerbosityLevel Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_DiagnosticSetting
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_DiagnosticSetting
ValueMapstring
[See below.]
CIM_DiagnosticSetting
ValuesstringMinimum
Standard
Full
CIM_DiagnosticSetting
ArrayTypestringIndexed CIM_DiagnosticSetting
ModelCorrespondencestringCIM_DiagnosticSetting.LogOptions CIM_DiagnosticSetting

NameValue
2Minimum
3Standard
4Full
Property Locales Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_DiagnosticSetting
DescriptionstringThis property, along with the locale information in LocalizationCapabilities and DiagnosticServiceRecord, meets the requirement to specify locale for results produced by a diagnostic service. A locale indicates a particular geographical, political, or cultural region. The Locales property of the DiagnosticSetting class is an array of strings whose entries specify a language to be used in the formulation of information requested by or delivered to a client as a result of running a diagnostic service. It is specified by the client as an input parameter to the RunDiagnostic method, by virtue of its inclusion in this Setting class which is a parameter of the method. A single Setting object may specify more than one Locale. In this case, information MUST be returned in each language specified. Each array entry 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_DiagnosticSetting
ModelCorrespondencestringCIM_LocalizationCapabilities.SupportedOutputLocales CIM_DiagnosticSetting

Property SettingID Qualifiers
NameTypeValueFrom Class
DescriptionstringThe identifier by which the Setting object is known. CIM_Setting
MaxLenuint32256 CIM_Setting

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

NameTypeValueQualifiersParametersClassOrigin
VerifyOKToApplyToMSEuint32 Description TimeToApply
MustBeCompletedBy
CIM_Setting
ApplyToMSEuint32 Description TimeToApply
MustBeCompletedBy
CIM_Setting
VerifyOKToApplyToCollectionuint32 Description TimeToApply
MustBeCompletedBy
CanNotApply
CIM_Setting
ApplyToCollectionuint32 Description TimeToApply
ContinueOnError
MustBeCompletedBy
CanNotApply
CIM_Setting
VerifyOKToApplyIncrementalChangeToMSEuint32 Description TimeToApply
MustBeCompletedBy
PropertiesToApply
CIM_Setting
ApplyIncrementalChangeToMSEuint32 Description TimeToApply
MustBeCompletedBy
PropertiesToApply
CIM_Setting
VerifyOKToApplyIncrementalChangeToCollectionuint32 Description TimeToApply
MustBeCompletedBy
PropertiesToApply
CanNotApply
CIM_Setting
ApplyIncrementalChangeToCollectionuint32 Description TimeToApply
ContinueOnError
MustBeCompletedBy
PropertiesToApply
CanNotApply
CIM_Setting

Method Qualifiers

Method VerifyOKToApplyToMSE Qualifiers
NameTypeValueFrom Class
DescriptionstringThe VerifyOKToApplyToMSE method is used to verify that this Setting can be applied to the referenced ManagedSystemElement at the given time or time interval. This method takes three input parameters: MSE (the Managed SystemElement that is being verified), TimeToApply (which, being a datetime, can be either a specific time or a time interval), and MustBeCompletedBy (which indicates the required completion time for the method). The return value should be 0 if it is okay to apply the Setting, 1 if the method is not supported, 2 if the Setting cannot be applied within the specified times, and any other number if an error occurred. In a subclass, the set of possible return codes could be specified using a ValueMap qualifier on the method. The strings to which the ValueMap contents are " translated " can also be specified in the subclass as a Values array qualifier. CIM_Setting

Method ApplyToMSE Qualifiers
NameTypeValueFrom Class
DescriptionstringThe ApplyToMSE method performs the actual application of the Setting to the referenced ManagedSystemElement. It takes three input parameters: MSE (the ManagedSystemElement to which the Setting is being applied), TimeToApply (which, being a datetime, can be either a specific time or a time interval), and MustBeCompletedBy (which indicates the required completion time for the method). Note that the semantics of this method are that individual Settings are either wholly applied or not applied at all to their target ManagedSystemElement. The return value should be 0 if the Setting is successfully applied to the referenced ManagedSystemElement, 1 if the method is not supported, 2 if the Setting was not applied within the specified times, and any other number if an error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are " translated " can also be specified in the subclass as a Values array qualifier. Note: If an error occurs when applying the Setting to a ManagedSystemElement, the Element must be configured as it was when the " Apply " attempt began. That is, the Element should not be left in an indeterminate state. CIM_Setting

Method VerifyOKToApplyToCollection Qualifiers
NameTypeValueFrom Class
DescriptionstringThe VerifyOKToApplyToCollection method is used to verify that this Setting can be applied to the referenced Collection of ManagedSystemElements, at the given time or time interval, without causing adverse effects to either the Collection itself or its surrounding environment. The net effect is to execute the VerifyOKToApply method against each of the Elements that are aggregated by the Collection. This method takes three input parameters: Collection (the Collection of ManagedSystemElements that is being verified), TimeToApply (which, being a datetime, can be either a specific time or a time interval), and MustBeCompletedBy (which indicates the required completion time for the method). The return value should be 0 if it is okay to apply the Setting, 1 if the method is not supported, 2 if the Setting cannot be applied within the specified times, and any other number if an error occurred. One output parameter, CanNotApply, is defined, which is a string array that lists the keys of the ManagedSystemElements to which the Setting cannot be applied. This parameter enables those Elements to be revisited and either fixed or have other corrective action taken on them. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are " translated " can also be specified in the subclass as a Values array qualifier. CIM_Setting

Method ApplyToCollection Qualifiers
NameTypeValueFrom Class
DescriptionstringThe ApplyToCollection method performs the application of the Setting to the referenced Collection of ManagedSystemElements. The net effect is to execute the ApplyToMSE method against each of the Elements that are aggregated by the Collection. If the input value ContinueOnError is false, this method applies the Setting to all Elements in the Collection until it encounters an error. In the case of an error, the method stops execution, logs the key of the Element that caused the error in the CanNotApply array, and issues a return code of 2. If the input value ContinueOnError is true, then this method applies the Setting to all of the ManagedSystemElements in the Collection, and reports the failed Elements in the array, CanNotApply. For the latter, processing will continue until the method is applied to all Elements in the Collection, regardless of any errors encountered. The key of each ManagedSystemElement to which the Setting could not be applied is logged into the CanNotApply array. This method takes four input parameters: Collection (the Collection of Elements to which the Setting is being applied), TimeToApply (which, being a datetime, can be either a specific time or a time interval), ContinueOnError (true indicates to continue processing when an error is encountered), and MustBeCompletedBy (which indicates the required completion time for the method). The return value should be 0 if the Setting is successfully applied to the referenced Collection, 1 if the method is not supported, 2 if the Setting was not applied within the specified times, 3 if the Setting cannot be applied using the input value for ContinueOnError, and any other number if an error occurred. One output parameter, CanNotApplystring, is defined, which is an array that lists the keys of the ManagedSystemElements to which the Setting could not be applied. This output parameter has meaning only when the ContinueOnError parameter is true. In a subclass, the set of possible return codes could be specified using a ValueMap qualifier on the method. The strings to which the ValueMap contents are " translated " can also be specified in the subclass as a Values array qualifier. Note: If an error occurs when applying the Setting to a ManagedSystemElement in the Collection, the Element must be configured as it was when the " Apply " attempt began. That is, the Element should not be left in an indeterminate state. CIM_Setting

Method VerifyOKToApplyIncrementalChangeToMSE Qualifiers
NameTypeValueFrom Class
DescriptionstringThe VerifyOKToApplyIncrementalChangeToMSE method is used to verify that a subset of the properties in this Setting can be applied to the referenced ManagedSystemElement at the given time or time interval. This method takes four input parameters: MSE (the ManagedSystemElement that is being verified), TimeToApply (which, being a datetime, can be either a specific time or a time interval), MustBeCompletedBy (which indicates the required completion time for the method), and a PropertiesToApply array (which contains a list of the property names whose values will be verified). If the array is null or empty or contains the string " ALL " as a property name, then all Settings properties will be verified. If it is set to " NONE " , then no Settings properties will be verified. The return value should be 0 if it is okay to apply the Setting, 1 if the method is not supported, 2 if the Setting cannot be applied within the specified times, and any other number if an error occurred. In a subclass, the set of possible return codes could be specified using a ValueMap qualifier on the method. The strings to which the ValueMap contents are " translated " can also be specified in the subclass as a Values array qualifier. CIM_Setting

Method ApplyIncrementalChangeToMSE Qualifiers
NameTypeValueFrom Class
DescriptionstringThe ApplyIncrementalChangeToMSE method performs the actual application of a subset of the properties in the Setting to the referenced ManagedSystemElement. It takes four input parameters: MSE (the ManagedSystem Element to which the Setting is being applied), TimeToApply (which, being a datetime, can be either a specific time or a time interval), MustBeCompletedBy (which indicates the required completion time for the method), and a PropertiesToApply array (which contains a list of the property names whose values will be applied). If a property is not in this list, it will be ignored by the Apply. If the array is null, empty, or contains the string " ALL " as a property name, then all Settings properties will be applied. If it is set to " NONE " , then no Settings properties will be applied. Note that the semantics of this method are that individual Settings are either wholly applied or not applied at all to their target ManagedSystemElement. The return value should be 0 if the Setting is successfully applied to the referenced ManagedSystemElement, 1 if the method is not supported, 2 if the Setting was not applied within the specified times, and any other number if an error occurred. In a subclass, the set of possible return codes could be specified using a ValueMap qualifier on the method. The strings to which the ValueMap contents are " translated " can also be specified in the subclass as a Values array qualifier. Note: If an error occurs when applying the Setting to a ManagedSystemElement, the Element must be configured as it was when the " Apply " attempt began. That is, the Element should not be left in an indeterminate state. CIM_Setting

Method VerifyOKToApplyIncrementalChangeToCollection Qualifiers
NameTypeValueFrom Class
DescriptionstringThe VerifyOKToApplyIncrementalChangeToCollection method is used to verify that a subset of the properties in this Setting can be applied to the referenced Collection of ManagedSystemElements at the given time or time interval, without causing adverse effects to either the Collection itself or its surrounding environment. The net effect is to execute the VerifyOKToApplyIncrementalChangeToMSE method against each of the Elements that are aggregated by the Collection. This method takes four input parameters: Collection (the Collection of ManagedSystemElements that is being verified), TimeToApply (which, being a datetime, can be either a specific time or a time interval), MustBeCompletedBy (which indicates the required completion time for the method), and a PropertiesToApply array (which contains a list of the property names whose values will be verified). If the array is null or empty or contains the string " all " as a property name, all Settings properties will be verified. If it is set to " none " then no Settings properties will be verified. The return value should be 0 if it is okay to apply the Setting, 1 if the method is not supported, 2 if the Setting cannot be applied within the specified times, and any other number if an error occurred. One output parameter, CanNotApply, is defined, which is a string array that lists the keys of the ManagedSystemElements to which the Setting cannot be applied. This parameter enables those Elements to be revisited and either fixed or have other corrective action taken on them. In a subclass, the set of possible return codes could be specified using a ValueMap qualifier on the method. The strings to which the ValueMap contents are " translated " can also be specified in the subclass as a Values array qualifier. CIM_Setting

Method ApplyIncrementalChangeToCollection Qualifiers
NameTypeValueFrom Class
DescriptionstringThe ApplyIncrementalChangeToCollection method performs the application of a subset of the properties in this Setting to the referenced Collection of ManagedSystemElements. The net effect is to execute the ApplyIncrementalChangeToMSE method against each of the Elements that are aggregated by the Collection. If the input value ContinueOnError is false, this method applies the Setting to all Elements in the Collection until it encounters an error, in which case it stops execution, logs the key of the Element that caused the error in the CanNotApply array, and issues a return code of 2. If the input value ContinueOnError is true, then this method applies the Setting to all of the ManagedSystemElements in the Collection, and reports the failed Elements in the array, CanNotApply. For the latter, processing will continue until the method is applied to all Elements in the Collection, regardless of any errors encountered. The key of each ManagedSystemElement to which the Setting could not be applied is logged into the CanNotApply array. This method takes four input parameters: Collection (the Collection of Elements to which the Setting is being applied), TimeToApply (which, being a datetime, can be either a specific time or a time interval), ContinueOnError (true indicates to continue processing when an error is encountered), MustBeCompletedBy (which indicates the required completion time for the method), and a PropertiesToApply array (which contains a list of the property names whose values will be applied). If a property is not in this list, it will be ignored by the Apply. If the array is null or empty or contains the string " ALL " as a property name, then all Settings properties will be applied. If it is set to " NONE " , then no Settings properties will be applied. The return value should be 0 if the Setting is successfully applied to the referenced Collection, 1 if the method is not supported, 2 if the Setting was not applied within the specified time, 3 if the Setting cannot be applied using the input value for ContinueOnError, and any other number if an error occurred. One output parameter, CanNotApplystring, is defined, which is an array that lists the keys of the ManagedSystemElements to which the Setting could not be applied. This output parameter has meaning only when the ContinueOnError parameter is true. In a subclass, the set of possible return codes could be specified using a ValueMap qualifier on the method. The strings to which the ValueMap contents are " translated " can also be specified in the subclass as a Values array qualifier. Note: If an error occurs when applying the Setting to a ManagedSystemElement in the Collection, the Element must be configured as it was when the " Apply " attempt began. That is, the Element should not be left in an indeterminate state. CIM_Setting

Parameters

Method VerifyOKToApplyToMSE Parameters
NameTypeQualifiers
TimeToApplydatetimeIN
Description
MustBeCompletedBydatetimeIN
Description

Method ApplyToMSE Parameters
NameTypeQualifiers
TimeToApplydatetimeIN
Description
MustBeCompletedBydatetimeIN
Description

Method VerifyOKToApplyToCollection Parameters
NameTypeQualifiers
TimeToApplydatetimeIN
Description
MustBeCompletedBydatetimeIN
Description
CanNotApplystringIN
OUT
Description

Method ApplyToCollection Parameters
NameTypeQualifiers
TimeToApplydatetimeIN
Description
ContinueOnErrorbooleanIN
Description
MustBeCompletedBydatetimeIN
Description
CanNotApplystringIN
OUT
Description

Method VerifyOKToApplyIncrementalChangeToMSE Parameters
NameTypeQualifiers
TimeToApplydatetimeIN
Description
MustBeCompletedBydatetimeIN
Description
PropertiesToApplystringIN
Description

Method ApplyIncrementalChangeToMSE Parameters
NameTypeQualifiers
TimeToApplydatetimeIN
Description
MustBeCompletedBydatetimeIN
Description
PropertiesToApplystringIN
Description

Method VerifyOKToApplyIncrementalChangeToCollection Parameters
NameTypeQualifiers
TimeToApplydatetimeIN
Description
MustBeCompletedBydatetimeIN
Description
PropertiesToApplystringIN
Description
CanNotApplystringIN
OUT
Description

Method ApplyIncrementalChangeToCollection Parameters
NameTypeQualifiers
TimeToApplydatetimeIN
Description
ContinueOnErrorbooleanIN
Description
MustBeCompletedBydatetimeIN
Description
PropertiesToApplystringIN
Description
CanNotApplystringIN
OUT
Description

Parameter Qualifiers

Parameter TimeToApply Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Setting
DescriptionstringTimeToApply can be either a specific time or a time interval. CIM_Setting

Parameter MustBeCompletedBy Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Setting
DescriptionstringThe required completion time for the method. CIM_Setting

Parameter TimeToApply Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Setting
DescriptionstringTimeToApply can be either a specific time or a time interval. CIM_Setting

Parameter MustBeCompletedBy Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Setting
DescriptionstringThe required completion time for the method. CIM_Setting

Parameter TimeToApply Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Setting
DescriptionstringTimeToApply can be either a specific time or a time interval. CIM_Setting

Parameter MustBeCompletedBy Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Setting
DescriptionstringThe required completion time for the method. CIM_Setting

Parameter CanNotApply Qualifiers
NameTypeValueFrom Class
INbooleanfalse CIM_Setting
OUTbooleantrue CIM_Setting
DescriptionstringA string array that lists the keys of the ManagedSystemElements to which the Setting cannot be applied. CIM_Setting

Parameter TimeToApply Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Setting
DescriptionstringTimeToApply can be either a specific time or a time interval. CIM_Setting

Parameter ContinueOnError Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Setting
DescriptionstringTrue means to continue processing when an error is encountered. CIM_Setting

Parameter MustBeCompletedBy Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Setting
DescriptionstringThe required completion time for the method. CIM_Setting

Parameter CanNotApply Qualifiers
NameTypeValueFrom Class
INbooleanfalse CIM_Setting
OUTbooleantrue CIM_Setting
DescriptionstringA string array that lists the keys of the ManagedSystemElements to which the Setting could not be applied. CIM_Setting

Parameter TimeToApply Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Setting
DescriptionstringTimeToApply can be either a specific time or a time interval. CIM_Setting

Parameter MustBeCompletedBy Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Setting
DescriptionstringThe required completion time for the method. CIM_Setting

Parameter PropertiesToApply Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Setting
DescriptionstringA list of the property names whose values will be verified. CIM_Setting

Parameter TimeToApply Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Setting
DescriptionstringTimeToApply can be either a specific time or a time interval. CIM_Setting

Parameter MustBeCompletedBy Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Setting
DescriptionstringThe required completion time for the method. CIM_Setting

Parameter PropertiesToApply Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Setting
DescriptionstringA list of the property names whose values will be applied. CIM_Setting

Parameter TimeToApply Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Setting
DescriptionstringTimeToApply can be either a specific time or a time interval. CIM_Setting

Parameter MustBeCompletedBy Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Setting
DescriptionstringThe required completion time for the method. CIM_Setting

Parameter PropertiesToApply Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Setting
DescriptionstringA list of the property names whose values will be verified. CIM_Setting

Parameter CanNotApply Qualifiers
NameTypeValueFrom Class
INbooleanfalse CIM_Setting
OUTbooleantrue CIM_Setting
DescriptionstringA string array that lists the keys of the ManagedSystemElements to which the Setting cannot be applied. CIM_Setting

Parameter TimeToApply Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Setting
DescriptionstringA specific time or a time interval. CIM_Setting

Parameter ContinueOnError Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Setting
DescriptionstringTrue indicates to continue processing when an error is encountered. CIM_Setting

Parameter MustBeCompletedBy Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Setting
DescriptionstringThis parameter indicates the required completion time for the method. CIM_Setting

Parameter PropertiesToApply Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Setting
DescriptionstringA list of the property names whose values will be verified. CIM_Setting

Parameter CanNotApply Qualifiers
NameTypeValueFrom Class
INbooleanfalse CIM_Setting
OUTbooleantrue CIM_Setting
DescriptionstringA string array that lists the keys of the ManagedSystemElements to which the Setting cannot be applied. CIM_Setting

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_DiagnosticSettingForTestCIM_DiagnosticSettingSetting
CIM_SettingContextCIM_SettingSetting
CIM_CollectionSettingCIM_SettingSetting
CIM_ElementSettingCIM_SettingSetting
CIM_DefaultSettingCIM_SettingSetting
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