Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary
CIM_DiagnosticTest --> CIM_DiagnosticService --> CIM_Service --> CIM_EnabledLogicalElement --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]
Class Declaration Attributes Name Value SUPERCLASS CIM_DiagnosticService NAME CIM_DiagnosticTest
Class CIM_DiagnosticTest Qualifiers Name Type Value From Class Version string 2.11.0 CIM_DiagnosticTest Description string The CIM_DiagnosticTest class represents the framework for running diagnostic tests. Specific diagnostic tests may be defined by subclassing and/or instantiating this object. To provide more detail for a type of test(s) (i.e, additional properties and methods), subclassing is appropriate. When a DiagnosticTest can be simultaneously executed against several elements, then DiagnosticTest may launch a ConcreteJob to represent each execution. CIM_DiagnosticTest Description string The CIM_DiagnosticService class provides the ability to start a service that functions to participate in a problem determination process. Specific diagnostic services SHOULD be defined by subclassing this class. Examples of a diagnostic service are tests, information retrievers, exercisers, and ports to external executives. CIM_DiagnosticService Description string A CIM_Service is a Logical Element that contains the information that is necessary to represent and manage the functionality provided by a Device or a SoftwareFeature, or both. A Service is a general-purpose object that is used to configure and manage the implementation of functionality. It is not the functionality itself. CIM_Service Description string This class extends LogicalElement to abstract the concept of an element that is enabled and disabled, such as a LogicalDevice or a ServiceAccessPoint. CIM_EnabledLogicalElement Description string CIM_LogicalElement is a base class for all the components of a System that represent abstract system components, such as Files, Processes, or LogicalDevices. CIM_LogicalElement Description string CIM_ManagedSystemElement is the base class for the System Element hierarchy. Any distinguishable component of a System is a candidate for inclusion in this class. Examples of system components include: - software components such as application servers, databases, and applications - operating system components such as files, processes, and threads - device components such as disk drives, controllers, processors, and printers - physical components such as chips and cards. CIM_ManagedSystemElement Description string ManagedElement 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
Property Qualifiers
Property Characteristics Qualifiers Name Type Value From Class Description string The descriptions for each Characteristic are below: * " Is Exclusive " (value=2) is specified for the test module only if the diagnostic cannot run more than one test at a time, regardless of how many SystemElements are supported. Typically, this occurs when hardware or software constraints prevent the test from running as multiple, concurrent instances. If the diagnostic can be run against multiple SystemElements, but only once per Element, then set the IsExclusiveForMSE boolean property on the appropriate instances of DiagnosticTestForMSE. * If " Is Interactive " (value=3) is set, then the diagnostic displays a message either before, during or after testing. * Set " Is Destructive " (value=4) if the diagnostic will destroy data, or reconfigure the Element that is being tested. * " Is Risky " (value=5) indicates that data loss may occur if the test is interrupted. Some tests make copies of data, perform the test, and restore the data returning the tested entity to its previous configuration. If the test is interrupted, then loss of data or reconfiguration of the tested ManagedSystemElement may occur. * If " Is Package " (value=6) is set, this test is actually a set of lower level diagnostics, that are packaged together by the test. This packaging is implemented by the diagnostic test, not aggregated by CIM. Information and results associated with the individual tests in the package may be requested by using the " Subtests " value in the DiagnosticSettingData.LogOptions array. (value=7) was " Supports PercentOfTestCoverage " in Version 2.6. Value = 7 is being deprecated. Instead, it should be described in DiagnosticServiceCapabilities. " Is Synchronous " (value=8) indicates that this diagnostic service will complete before the RunDiagnostic method returns to the caller. A Job is still created that can be accessed by the client for accounting purposes, but the ability to track progress and status of the Job are lost. Additionally, in certain environments, the client may be " blocked " from further action until the service completes. " Media Required " (value=9) indicates that this diagnostic service requires that media be inserted into the device in order to perform the service. " Additional Hardware Required " (value=10) indicates that this diagnostic service requires that some additional hardware is installed (e.g., wrap plug) in order to perform the service. CIM_DiagnosticTest ValueMap string [See below.] CIM_DiagnosticTest Values string Unknown
Other
Is Exclusive
Is Interactive
Is Destructive
Is Risky
Is Package
Reserved
Is Synchronous
Media Required
Additional Hardware RequiredCIM_DiagnosticTest ModelCorrespondence string CIM_DiagnosticTest.OtherCharacteristicsDescriptions CIM_DiagnosticTest
Name Value 0 Unknown 1 Other 2 Is Exclusive 3 Is Interactive 4 Is Destructive 5 Is Risky 6 Is Package 7 Reserved 8 Is Synchronous 9 Media Required 10 Additional Hardware Required
Property OtherCharacteristicDescription Qualifiers Name Type Value From Class Description string Provides additional information for the Characteristic when its value is set to 1 ( " Other " ). CIM_DiagnosticTest ModelCorrespondence string CIM_DiagnosticTest.Characteristics CIM_DiagnosticTest
Property OtherCharacteristicsDescriptions Qualifiers Name Type Value From Class Description string OtherCharacteristicsDescriptions is a Bag array that contains an element with additional information for each Characteristics element with a value of 1 ( " Other " ). CIM_DiagnosticTest ModelCorrespondence string CIM_DiagnosticTest.Characteristics CIM_DiagnosticTest
Property IsInUse Qualifiers Name Type Value From Class Description string This property is being deprecated. The boolean Started property inherited from CIM_Service should be used instead. If this test is currently being performed, the InUse property is set to TRUE. To determine which ManagedSystem Element is being tested, query the DiagnosticResult objects associated with this test (query DiagnosticResultForTest), and for which the TestState equals 4 ( " In Progress " ). The DiagnosticResult object is associated with the System Element under test, using DiagnosticResultForMSE. CIM_DiagnosticTest
Property ResourcesUsed Qualifiers Name Type Value From Class Description string This property is being deprecated and replaced with a more general method for indicating Managed Elements that are affected by this Test. The DiagnosticService parent has a ServiceAffectsElement association to a Managed Element for this purpose. The " Expensive " qualifier can be applied to this class and its RunTest method. If so, the ResourcesUsed property describes the resources that are capitalized, based on a default setup for the test. Multiple resources can be specified since the property is an array. CIM_DiagnosticTest ValueMap string [See below.] CIM_DiagnosticTest Values string CPU
Memory
Hard Disk
CDROM
Floppy
PCI Bus
USB Bus
1394 Bus
SCSI Bus
IDE Bus
Network
ISA Bus
EISA Bus
VESA Bus
PCMCIA Bus
CardBus
Access.bus
NuBus
AGP
VME Bus
Sbus IEEE 1396-1993
MCA Bus
GIO Bus
XIO Bus
HIO Bus
PMC Bus
SIO BusCIM_DiagnosticTest
Name Value 2 CPU 3 Memory 4 Hard Disk 5 CDROM 6 Floppy 7 PCI Bus 8 USB Bus 9 1394 Bus 10 SCSI Bus 11 IDE Bus 12 Network 13 ISA Bus 14 EISA Bus 15 VESA Bus 16 PCMCIA Bus 17 CardBus 18 Access.bus 19 NuBus 20 AGP 21 VME Bus 22 Sbus IEEE 1396-1993 23 MCA Bus 24 GIO Bus 25 XIO Bus 26 HIO Bus 27 PMC Bus 28 SIO Bus
Property TestTypes Qualifiers Name Type Value From Class Description string The descriptions for each test type are below: * If " Functional " (value=2) is set, this tests one, more or all the functionality of the element. * If " Stress " (value=3) is set, this test is a stress test or exerciser for the element. * If " Health Check " (value=4) is set, this test validates the current health of the element. * If " Access Test " (value=5) is set, this test verifies the element is accessible to the system and user. This would include access through the OS as a user would access the element. * If " Media Verify " (value=6) is set, this test verifies the media for the element. This does not validate that specific data is correctly written on the media or even if data can be written to the media, but verifies that the media itself has no faults. CIM_DiagnosticTest ValueMap string [See below.] CIM_DiagnosticTest Values string Unknown
Other
Functional
Stress
Health Check
Access Test
Media Verify
DMTF Reserved
Vendor ReservedCIM_DiagnosticTest ArrayType string Indexed CIM_DiagnosticTest ModelCorrespondence string CIM_DiagnosticTest.OtherTestTypesDescriptions CIM_DiagnosticTest
Name Value 0 Unknown 1 Other 2 Functional 3 Stress 4 Health Check 5 Access Test 6 Media Verify .. DMTF Reserved 0x8000.. Vendor Reserved
Property OtherTestTypesDescriptions Qualifiers Name Type Value From Class Description string OtherTestTypesDescriptions is an array that contains an element with additional information for each TestTypes element with a value of 1 ( " Other " ). CIM_DiagnosticTest ArrayType string Indexed CIM_DiagnosticTest ModelCorrespondence string CIM_DiagnosticTest.TestTypes CIM_DiagnosticTest
Property SystemCreationClassName Qualifiers Name Type Value From Class Key boolean true CIM_Service Propagated string CIM_System.CreationClassName CIM_Service Description string The CreationClassName of the scoping System. CIM_Service MaxLen uint32 256 CIM_Service
Property SystemName Qualifiers Name Type Value From Class Key boolean true CIM_Service Propagated string CIM_System.Name CIM_Service Description string The Name of the scoping System. CIM_Service MaxLen uint32 256 CIM_Service
Property CreationClassName Qualifiers Name Type Value From Class Key boolean true CIM_Service Description string CreationClassName indicates the name of the class or the subclass that is used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified. CIM_Service MaxLen uint32 256 CIM_Service
Property Name Qualifiers Name Type Value From Class Key boolean true CIM_Service Override string Name CIM_Service Description string The Name property uniquely identifies the Service and provides an indication of the functionality that is managed. This functionality is described in more detail in the Description property of the object. CIM_Service MaxLen uint32 256 CIM_Service
Property PrimaryOwnerName Qualifiers Name Type Value From Class Write boolean true CIM_Service Description string The name of the primary owner for the service, if one is defined. The primary owner is the initial support contact for the Service. CIM_Service MaxLen uint32 64 CIM_Service MappingStrings string MIF.DMTF|General Information|001.3 CIM_Service
Property PrimaryOwnerContact Qualifiers Name Type Value From Class Write boolean true CIM_Service Description string A string that provides information on how the primary owner of the Service can be reached (for example, phone number, e-mail address, and so on). CIM_Service MaxLen uint32 256 CIM_Service MappingStrings string MIF.DMTF|General Information|001.4 CIM_Service
Property StartMode Qualifiers Name Type Value From Class Description string Note: The use of this element is deprecated in lieu of the EnabledDefault property that is inherited from EnabledLogicalElement. The EnabledLogicalElement addresses the same semantics. The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property. To remain compatible with those implementations, StartMode was grandfathered into the schema. Use of the deprecated qualifier allows the maintenance of the existing property but also permits an improved, clarified definition using EnabledDefault. Deprecated description: StartMode is a string value that indicates whether the Service is automatically started by a System, an Operating System, and so on, or is started only upon request. CIM_Service ValueMap string [See below.] CIM_Service MaxLen uint32 10 CIM_Service
Name Value Automatic [none] Manual [none]
Property Started Qualifiers Name Type Value From Class Description string Started is a Boolean that indicates whether the Service has been started (TRUE), or stopped (FALSE). CIM_Service
Property EnabledState Qualifiers Name Type Value From Class Description string EnabledState is an integer enumeration that indicates the enabled and disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value=4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled and disabled states: Enabled (2) indicates that the element is or could be executing commands, will process any queued commands, and queues new requests. Disabled (3) indicates that the element will not execute commands and will drop any new requests. Shutting Down (4) indicates that the element is in the process of going to a Disabled state. Not Applicable (5) indicates the element does not support being enabled or disabled. Enabled but Offline (6) indicates that the element might be completing commands, and will drop any new requests. Test (7) indicates that the element is in a test state. Deferred (8) indicates that the element might be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The behavior of the element is similar to the Enabled state, but it processes only a restricted set of commands. All other requests are queued. Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued. CIM_EnabledLogicalElement ValueMap string [See below.] CIM_EnabledLogicalElement Values string Unknown
Other
Enabled
Disabled
Shutting Down
Not Applicable
Enabled but Offline
In Test
Deferred
Quiesce
Starting
DMTF Reserved
Vendor ReservedCIM_EnabledLogicalElement ModelCorrespondence string CIM_EnabledLogicalElement.OtherEnabledState CIM_EnabledLogicalElement
Name Value 0 Unknown 1 Other 2 Enabled 3 Disabled 4 Shutting Down 5 Not Applicable 6 Enabled but Offline 7 In Test 8 Deferred 9 Quiesce 10 Starting 11..32767 DMTF Reserved 32768..65535 Vendor Reserved
Property OtherEnabledState Qualifiers Name Type Value From Class Description string A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ( " Other " ). This property must be set to null when EnabledState is any value other than 1. CIM_EnabledLogicalElement ModelCorrespondence string CIM_EnabledLogicalElement.EnabledState CIM_EnabledLogicalElement
Property RequestedState Qualifiers Name Type Value From Class Description string RequestedState is an integer enumeration that indicates the last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. Note that when EnabledState is set to 5 ( " Not Applicable " ), then this property has no meaning. By default, the RequestedState of the element is 5 ( " No Change " ). Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration. It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are " Reboot " (10) and " Reset " (11). Reboot refers to doing a " Shut Down " and then moving to an " Enabled " state. Reset indicates that the element is first " Disabled " and then " Enabled " . The distinction between requesting " Shut Down " and " Disabled " should also be noted. Shut Down requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state. The Disabled state requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, because it allows an explicit invocation of the operation and the return of a result code. A particular instance of EnabledLogicalElement might not support RequestedStateChange. If this occurs, the value 12 ( " Not Applicable " ) is used. CIM_EnabledLogicalElement ValueMap string [See below.] CIM_EnabledLogicalElement Values string Enabled
Disabled
Shut Down
No Change
Offline
Test
Deferred
Quiesce
Reboot
Reset
Not Applicable
DMTF Reserved
Vendor ReservedCIM_EnabledLogicalElement ModelCorrespondence string CIM_EnabledLogicalElement.EnabledState CIM_EnabledLogicalElement
Name Value 2 Enabled 3 Disabled 4 Shut Down 5 No Change 6 Offline 7 Test 8 Deferred 9 Quiesce 10 Reboot 11 Reset 12 Not Applicable .. DMTF Reserved 32768..65535 Vendor Reserved
Property EnabledDefault Qualifiers Name Type Value From Class Write boolean true CIM_EnabledLogicalElement Description string An enumerated value indicating an administrator ’ s default or startup configuration for the Enabled State of an element. By default, the element is " Enabled " (value=2). CIM_EnabledLogicalElement ValueMap string [See below.] CIM_EnabledLogicalElement Values string Enabled
Disabled
Not Applicable
Enabled but Offline
No Default
DMTF Reserved
Vendor ReservedCIM_EnabledLogicalElement
Name Value 2 Enabled 3 Disabled 5 Not Applicable 6 Enabled but Offline 7 No Default 8..32767 DMTF Reserved 32768..65535 Vendor Reserved
Property TimeOfLastStateChange Qualifiers Name Type Value From Class Description string The date or time when the EnabledState of the element last changed. If the state of the element has not changed and this property is populated, then it must be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property must not be updated. CIM_EnabledLogicalElement
Property InstallDate Qualifiers Name Type Value From Class Description string A datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed. CIM_ManagedSystemElement MappingStrings string MIF.DMTF|ComponentID|001.5 CIM_ManagedSystemElement
Property Name Qualifiers Name Type Value From Class Description string The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property. CIM_ManagedSystemElement MaxLen uint32 1024 CIM_ManagedSystemElement
Property OperationalStatus Qualifiers Name Type Value From Class Description string Indicates the current statuses of the element. Various operational statuses are defined. Many of the enumeration ’ s values are self-explanatory. However, a few are not and are described here in more detail. " Stressed " indicates that the element is functioning, but needs attention. Examples of " Stressed " states are overload, overheated, and so on. " Predictive Failure " indicates that an element is functioning nominally but predicting a failure in the near future. " In Service " describes an element being configured, maintained, cleaned, or otherwise administered. " No Contact " indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it. " Lost Communication " indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable. " Stopped " and " Aborted " are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the state and configuration of the element might need to be updated. " Dormant " indicates that the element is inactive or quiesced. " Supporting Entity in Error " indicates that this element might be " OK " but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower-layer networking problems. " Completed " indicates that the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error). " Power Mode " indicates that the element has additional power model information contained in the Associated PowerManagementService association. OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today ’ s environment to the future. This change was not made earlier because it required the deprecated qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly recommended that providers or instrumentation provide both the Status and OperationalStatus properties. Further, the first value of OperationalStatus should contain the primary status for the element. When instrumented, Status (because it is single-valued) should also provide the primary status of the element. CIM_ManagedSystemElement ValueMap string [See below.] CIM_ManagedSystemElement Values string Unknown
Other
OK
Degraded
Stressed
Predictive Failure
Error
Non-Recoverable Error
Starting
Stopping
Stopped
In Service
No Contact
Lost Communication
Aborted
Dormant
Supporting Entity in Error
Completed
Power Mode
DMTF Reserved
Vendor ReservedCIM_ManagedSystemElement ArrayType string Indexed CIM_ManagedSystemElement ModelCorrespondence string CIM_ManagedSystemElement.StatusDescriptions CIM_ManagedSystemElement
Name Value 0 Unknown 1 Other 2 OK 3 Degraded 4 Stressed 5 Predictive Failure 6 Error 7 Non-Recoverable Error 8 Starting 9 Stopping 10 Stopped 11 In Service 12 No Contact 13 Lost Communication 14 Aborted 15 Dormant 16 Supporting Entity in Error 17 Completed 18 Power Mode .. DMTF Reserved 0x8000.. Vendor Reserved
Property StatusDescriptions Qualifiers Name Type Value From Class Description string Strings describing the various OperationalStatus array values. For example, if " Stopping " is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Note that entries in this array are correlated with those at the same array index in OperationalStatus. CIM_ManagedSystemElement ArrayType string Indexed CIM_ManagedSystemElement ModelCorrespondence string CIM_ManagedSystemElement.OperationalStatus CIM_ManagedSystemElement
Property Status Qualifiers Name Type Value From Class Description string A string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons: 1) Status is more correctly defined as an array. This definition overcomes the limitation of describing status using a single value, when it is really a multi-valued property (for example, an element might be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. 3) The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus. CIM_ManagedSystemElement ValueMap string [See below.] CIM_ManagedSystemElement MaxLen uint32 10 CIM_ManagedSystemElement
Name Value OK [none] Error [none] Degraded [none] Unknown [none] Pred Fail [none] Starting [none] Stopping [none] Service [none] Stressed [none] NonRecover [none] No Contact [none] Lost Comm [none] Stopped [none]
Property HealthState Qualifiers Name Type Value From Class Description string Indicates the current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely non-functional. The following continuum is defined: " Non-recoverable Error " (30) - The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost. " Critical Failure " (25) - The element is non-functional and recovery might not be possible. " Major Failure " (20) - The element is failing. It is possible that some or all of the functionality of this component is degraded or not working. " Minor Failure " (15) - All functionality is available but some might be degraded. " Degraded/Warning " (10) - The element is in working order and all functionality is provided. However, the element is not working to the best of its abilities. For example, the element might not be operating at optimal performance or it might be reporting recoverable errors. " OK " (5) - The element is fully functional and is operating within normal operational parameters and without error. " Unknown " (0) - The implementation cannot report on HealthState at this time. DMTF has reserved the unused portion of the continuum for additional HealthStates in the future. CIM_ManagedSystemElement ValueMap string [See below.] CIM_ManagedSystemElement Values string Unknown
OK
Degraded/Warning
Minor failure
Major failure
Critical failure
Non-recoverable error
DMTF ReservedCIM_ManagedSystemElement
Name Value 0 Unknown 5 OK 10 Degraded/Warning 15 Minor failure 20 Major failure 25 Critical failure 30 Non-recoverable error .. DMTF Reserved
Property Caption Qualifiers Name Type Value From Class Description string The Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement MaxLen uint32 64 CIM_ManagedElement
Property Description Qualifiers Name Type Value From Class Description string The Description property provides a textual description of the object. CIM_ManagedElement
Property ElementName Qualifiers Name Type Value From Class 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 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
Name Type Value Qualifiers Parameters ClassOrigin RunTest uint32 Deprecated
DescriptionCIM_DiagnosticTest ClearResults uint32 Deprecated
DescriptionResultsNotCleared CIM_DiagnosticTest DiscontinueTest uint32 Deprecated
DescriptionTestingStopped CIM_DiagnosticTest RunDiagnostic uint32 Deprecated
Description
ValueMap
ValuesCIM_DiagnosticService RunDiagnosticService uint32 Experimental
Description
ValueMap
ValuesDiagnosticSettings
JobSettingsCIM_DiagnosticService StartService uint32 Description CIM_Service StopService uint32 Description CIM_Service RequestStateChange uint32 Description
ValueMap
Values
ModelCorrespondenceRequestedState
TimeoutPeriodCIM_EnabledLogicalElement Method Qualifiers
Method RunTest Qualifiers Name Type Value From Class Description string This method is being deprecated and replaced by the RunDiagnostic method in the DiagnosticService class. The RunTest method executes this test for the specified ManagedSystemElement. The use of this method has been deprecated. Instead, the RunDiagnostic method (inherited from DiagnosticService) should be used. The RunTest method executes this test for the specified ManagedSystemElement (defined using the SystemElement input parameter). Results of the test are stored in a Diagnostic Result object, a reference to which is returned as the Result output parameter. How the test should execute, i.e. its settings, is defined in a DiagnosticSetting object (or by a subclass of DiagnosticSetting). A reference to a Setting object is specified using the Setting input parameter. If a reference is not passed into the method, then a default DiagnosticSetting may be used. This default Setting is associated with the DiagnoticTest using the DefaultSetting relationship of the Core Model. 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. The method ’ s return codes are expected to adhere to the XML return codes as they are introduced. Currently, the standard return values are: 0 = OK (function succeeded, but the test itself may have failed 1 = Unspecified Error (function failed for unspecified reasons) 2 = Not Implemented (function is not implemented for this instance) 3 = Out Of Resources (component could not allocate required resources, e.g. memory, disk space, etc.) 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 ’ may also be specified in the subclass as a Values array qualifier. CIM_DiagnosticTest
Method ClearResults Qualifiers Name Type Value From Class Description string This method is deprecated in favor of using the corresponding functionality contained in the Log class, this is consistant with the deprecation of the Result class in favor of Log. Execution of this method will delete all instances of the DiagnosticResultForMSE object, for this DiagnosticTest and the specified ManagedSystemElement (defined using the SystemElement input parameter). The DiagnosticResults referenced in the DiagnosticResultForMSE instances will be deleted. Also the association DiagnosticResultForTest that refers to the DiagnosticResult object, and this test will be deleted. One output parameter is defined - ResultsNotCleared - which is a string array that lists the keys of the DiagnosticResults which could not be deleted. This information enables those Results to be revisited and either manually removed, or other corrective action taken. The method ’ s return codes are expected to adhere to the XML return codes as they are introduced. Currently, the standard return values are: 0 = OK (function succeeded, but the test itself may have failed) 1 = Unspecified Error (function failed for unspecified reasons) 2 = Not Implemented (function is not implemented for this instance) 3 = Out Of Resources (component could not allocate required resources, e.g. memory, disk space, etc.) 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 ’ may also be specified in the subclass as a Values array qualifier. CIM_DiagnosticTest
Method DiscontinueTest Qualifiers Name Type Value From Class Description string After invocation of this method and its completion, the specified test(s) will be discontinued for the indicated ManagedSystemElement (defined by the SystemElement input parameter). The test to discontinue is specified using the Result input parameter. If all instances of this test should be stopped for the SystemElement, then the Result reference should be NULL. Upon completion of the method, test status and other information (such as PercentComplete) will be stored in the DiagnosticResult instance defined by the Result input parameter. The output parameter, TestingStopped, is used as follows: Set to TRUE if testing was successfully stopped. Set to FALSE if the current test(s) can not be stopped. If set to FALSE, testing will stop when the diagnostic is able to do so safely. To determine if/when the testing is stopped, check the TestState property in the DiagnosticResult instance defined by the Result parameter. TestState will change from " In Progress " to " Stopped " (from 4 to 5). The method ’ s return codes are expected to adhere to the XML return codes as they are introduced. Currently, the standard return values are: 0 = OK (function succeeded, but the test itself may have failed 1 = Unspecified Error (function failed for unspecified reasons) 2 = Not Implemented (function is not implemented for this instance) 3 = Out Of Resources (component could not allocate required resources, e.g. memory, disk space, etc.) 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 ’ may also be specified in the subclass as a Values array qualifier. CIM_DiagnosticTest
Method RunDiagnostic Qualifiers Name Type Value From Class Description string This method is being deprecated as part of the change to have Diagnostic Settings derive from CIM_SettingData instead of CIM_Setting. The RunDiagnostic method is invoked to commence execution of a diagnostic program on a specific managed element. The input parameters specify this managed element and the settings that SHALL be applied to the diagnostic and the resultant job. The method returns a reference to the ConcreteJob instance created. Prior to invoking this method, clients SHALL examine the appropriate capabilities and create valid DiagnosticSetting and JobSettingData instances to apply as input parameters. Since settings may be changed without warning, the RunDiagnostic method SHOULD immediately evaluate and capture the attributes of DiagnsoticSetting in an instance of DiagnosticSettingRecord. This information is useful for post-mortem analysis of diagnostic results. A job SHALL be instantiated as a means for monitoring the diagnostic as it runs and to provide useful accounting and status information once the diagnostic has completed. The " Busy " return code indicates that the method cannot be invoked " at this time " . It is not an error condition, but signals that the provider is doing something else and cannot respond. CIM_DiagnosticService ValueMap string [See below.] CIM_DiagnosticService Values string Success
Not Supported
Unknown
Timeout
Failed
Invalid Parameter
Busy
DMTF Reserved
Method Reserved
Vendor SpecificCIM_DiagnosticService
Method RunDiagnosticService Qualifiers Name Type Value From Class Description string The RunDiagnosticService method is invoked to commence execution of a diagnostic program on a specific managed element. The input parameters specify this managed element and the settings to be applied to the diagnostic and the resultant job. The method returns a reference to the ConcreteJob instance created. Prior to invoking this method, clients examine defaults and appropriate capabilities and create valid DiagnosticSettingData and JobSettingData instances to apply as input parameters. The RunDiagnosticService method SHALL evaluate and capture the attributes of DiagnosticSettingData in an instance of DiagnosticSettingDataRecord for use in post-mortem analysis of diagnostic results. A job SHALL be instantiated as a means for monitoring the diagnostic as it runs and to provide useful accounting and status information once the diagnostic has completed. The " Busy " return code indicates that the method cannot be invoked " at this time " . It is not an error condition, but signals that the provider is doing something else and cannot respond. CIM_DiagnosticService ValueMap string [See below.] CIM_DiagnosticService Values string Success
Not Supported
Unknown
Timeout
Failed
Invalid Parameter
Busy
DMTF Reserved
Method Reserved
Vendor SpecificCIM_DiagnosticService
Method StartService Qualifiers Name Type Value From Class Description string The StartService method places the Service in the started state. Note that the function of this method overlaps with the RequestedState property. RequestedState was added to the model to maintain a record (such as a persisted value) of the last state request. Invoking the StartService method should set the RequestedState property appropriately. The method returns an integer value of 0 if the Service was successfully started, 1 if the request is not supported, and any other number to indicate an error. 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: The semantics of this method overlap with the RequestStateChange method that is inherited from EnabledLogicalElement. This method is maintained because it has been widely implemented, and its simple " start " semantics are convenient to use. CIM_Service
Method StopService Qualifiers Name Type Value From Class Description string The StopService method places the Service in the stopped state. Note that the function of this method overlaps with the RequestedState property. RequestedState was added to the model to maintain a record (such as a persisted value) of the last state request. Invoking the StopService method should set the RequestedState property appropriately. The method returns an integer value of 0 if the Service was successfully stopped, 1 if the request is not supported, and any other number to indicate an error. 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: The semantics of this method overlap with the RequestStateChange method that is inherited from EnabledLogicalElement. This method is maintained because it has been widely implemented, and its simple " stop " semantics are convenient to use. CIM_Service
Method RequestStateChange Qualifiers Name Type Value From Class Description string Requests that the state of the element be changed to the value specified in the RequestedState parameter. When the requested state change takes place, the EnabledState and RequestedState of the element will be the same. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten or lost. If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If 4096 (0x1000) is returned, then the task will take some time to complete, ConcreteJob will be created, and its reference returned in the output parameter Job. Any other return code indicates an error condition. CIM_EnabledLogicalElement ValueMap string [See below.] CIM_EnabledLogicalElement Values string Completed with No Error
Not Supported
Unknown or Unspecified Error
Cannot complete within Timeout Period
Failed
Invalid Parameter
In Use
DMTF Reserved
Method Parameters Checked - Job Started
Invalid State Transition
Use of Timeout Parameter Not Supported
Busy
Method Reserved
Vendor SpecificCIM_EnabledLogicalElement ModelCorrespondence string CIM_EnabledLogicalElement.RequestedState CIM_EnabledLogicalElement Parameters
Method ClearResults Parameters Name Type Qualifiers ResultsNotCleared string IN
OUT
Description
Method DiscontinueTest Parameters Name Type Qualifiers TestingStopped boolean IN
OUT
Description
Method RunDiagnosticService Parameters Name Type Qualifiers DiagnosticSettings string IN
Description
EmbeddedInstanceJobSettings string IN
Description
EmbeddedInstance
Method RequestStateChange Parameters Name Type Qualifiers RequestedState uint16 IN
Description
ValueMap
Values
ModelCorrespondenceTimeoutPeriod datetime IN
DescriptionParameter Qualifiers
Parameter ResultsNotCleared Qualifiers Name Type Value From Class IN boolean false CIM_DiagnosticTest OUT boolean true CIM_DiagnosticTest Description string A string array that lists the keys of the DiagnosticResults which could not be deleted. CIM_DiagnosticTest
Parameter TestingStopped Qualifiers Name Type Value From Class IN boolean false CIM_DiagnosticTest OUT boolean true CIM_DiagnosticTest Description string TestingStopped, is set to TRUE if testing was successfully stopped. It is set to FALSE if the current test(s) can not be stopped. If set to FALSE, testing will stop when the diagnostic is able to do so safely. To determine if/when the testing is stopped, check the TestState property in the DiagnosticResult instance defined by the Result parameter. TestState will change from " In Progress " to " Stopped " (from 4 to 5). CIM_DiagnosticTest
Parameter DiagnosticSettings Qualifiers Name Type Value From Class IN boolean true CIM_DiagnosticService Description string A string containing an encoding of the DiagnosticSettingData instance to be applied to the diagnostic. If null, the diagnostic ’ s defaults are used. CIM_DiagnosticService EmbeddedInstance string CIM_DiagnosticSettingData CIM_DiagnosticService
Parameter JobSettings Qualifiers Name Type Value From Class IN boolean true CIM_DiagnosticService Description string A string containing an encoding of the JobSettingData instance to be applied to the resulting job. If null, the job ’ s defaults are used. CIM_DiagnosticService EmbeddedInstance string CIM_JobSettingData CIM_DiagnosticService
Parameter RequestedState Qualifiers Name Type Value From Class IN boolean true CIM_EnabledLogicalElement Description string The state requested for the element. This information will be placed into the RequestedState property of the instance if the return code of the RequestStateChange method is 0 ( ’ Completed with No Error ’ ), 3 ( ’ Timeout ’ ), or 4096 (0x1000) ( ’ Job Started ’ ). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values. CIM_EnabledLogicalElement ValueMap string [See below.] CIM_EnabledLogicalElement Values string Enabled
Disabled
Shut Down
Offline
Test
Defer
Quiesce
Reboot
Reset
DMTF Reserved
Vendor ReservedCIM_EnabledLogicalElement ModelCorrespondence string CIM_EnabledLogicalElement.RequestedState CIM_EnabledLogicalElement
Parameter TimeoutPeriod Qualifiers Name Type Value From Class IN boolean true CIM_EnabledLogicalElement Description string A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation does not support this parameter, a return code of ’ Use Of Timeout Parameter Not Supported ’ must be returned. CIM_EnabledLogicalElement