System\CIM_DiagnosticTest.mof.mof (HTML version)

Return to index
CIM_DiagnosticTest Superclass: CIM_DiagnosticService
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.
Qualifiers:Version ( "2.11.0" )
Parameters (local in grey)
Values { "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 Bus" }
Deprecated { "CIM_ServiceAffectsElement" }
ValueMap { "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , "15" , "16" , "17" , "18" , "19" , "20" , "21" , "22" , "23" , "24" , "25" , "26" , "27" , "28" }
uint16 ResourcesUsed [ ] ;
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.
Deprecated { "CIM_DiagnosticService.RunDiagnostic" }
uint32RunTest(
The ManagedSystemElement on which the test will run.
Qualifiers:IN
CIM_ManagedSystemElement REF SystemElement
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.
Qualifiers:IN
CIM_DiagnosticSetting REF Setting
Results of the test are stored in a DiagnosticResult object, a reference to which is returned as the Result output parameter.
Qualifiers:OUT IN ( false )
CIM_DiagnosticResult REF Result
)
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.
ModelCorrespondence { "CIM_DiagnosticTest.Characteristics" }
Deprecated { "CIM_DiagnosticTest.OtherCharacteristicsDescriptions" }
string OtherCharacteristicDescription ;
Provides additional information for the Characteristic when its value is set to 1 ('Other').
Deprecated { "CIM_Service.Started" }
boolean IsInUse ;
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.
Deprecated { "CIM_ConcreteJob.RequestStateChange" }
uint32DiscontinueTest(
Testing will be discontinued for the indicated ManagedSystemElement defined by the SystemElement input parameter.
Qualifiers:IN
CIM_ManagedSystemElement REF SystemElement
The test to discontinue is specified using the Result input parameter.
Qualifiers:IN
CIM_DiagnosticResult REF Result
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).
Qualifiers:OUT IN ( false )
boolean TestingStopped
)
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.
Deprecated { "CIM_Log.ClearLog" }
uint32ClearResults(
The Managed System Element for which results will be cleared.
Qualifiers:IN
CIM_ManagedSystemElement REF SystemElement
A string array that lists the keys of the DiagnosticResults which could not be deleted.
Qualifiers:OUT IN ( false )
string ResultsNotCleared [ ]
)
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.
ModelCorrespondence { "CIM_DiagnosticTest.TestTypes" }
ArrayType ( "Indexed" )
string OtherTestTypesDescriptions [ ] ;
OtherTestTypesDescriptions is an array that contains an element with additional information for each TestTypes element with a value of 1 ('Other').
Values { "Unknown" , "Other" , "Functional" , "Stress" , "Health Check" , "Access Test" , "Media Verify" , "DMTF Reserved" , "Vendor Reserved" }
ModelCorrespondence { "CIM_DiagnosticTest.OtherTestTypesDescriptions" }
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "0x8000.." }
ArrayType ( "Indexed" )
uint16 TestTypes [ ] ;
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.
ModelCorrespondence { "CIM_DiagnosticTest.Characteristics" }
string OtherCharacteristicsDescriptions [ ] ;
OtherCharacteristicsDescriptions is a Bag array that contains an element with additional information for each Characteristics element with a value of 1 ('Other').
Values { "Unknown" , "Other" , "Is Exclusive" , "Is Interactive" , "Is Destructive" , "Is Risky" , "Is Package" , "Reserved" , "Is Synchronous" , "Media Required" , "Additional Hardware Required" }
ModelCorrespondence { "CIM_DiagnosticTest.OtherCharacteristicsDescriptions" }
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" }
uint16 Characteristics [ ] ;
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 DiagnosticSetting.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.
Values { "Job completed with no error" , "Not Supported" , "Unknown" , "Timeout" , "Failed" , "Invalid Parameter" , "DMTF Reserved" , "Method parameters checked - job started" , "Method Reserved" , "Vendor Specific" }
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , ".." , "0x1000" , ".." , "0x8000.." }
uint32RunDiagnostic(
Specifies the element upon which the DiagnosticService SHOULD be run.
Qualifiers:IN
CIM_ManagedElement REF ManagedElement
Specifies the desired settings that SHOULD be applied to the Diagnostic. If null, then the Diagnostic's defaults MAY be used.
Qualifiers:IN
CIM_DiagnosticSetting REF DiagSetting
Specifies the desired settings that SHOULD be applied to the resulting Job. If null and a resulting Job is required (i.e., the Diagnostic is long running), then the test's defaults MAY be used.
Qualifiers:IN
CIM_JobSettingData REF JobSetting
Returns a handle to the resulting Job.
Qualifiers:OUT IN ( FALSE )
CIM_ConcreteJob REF Job
)
The RunDiagnostic method executes this test for the specified ManagedSystemElement (defined using the SystemElement input parameter). The capabilities for the diagnostic service indicate where the results from the test job are stored. 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 SHALL be used.
When RunDiagnostic starts execution, the settings, which are time sensitive, SHOULD be evaluated and captured. This is suggested since the DiagnosticSetting object MAY be modified at any time, and therefore the current test settings could be lost.
If 0 is returned, the function completed successfully and no ConcreteJob instance is created. If 0x1000 a ConcreteJob will be started.
boolean Started ;
Started is a Boolean that indicates whether the Service has been started (TRUE), or stopped (FALSE).
Propagated ( "CIM_System.Name" )
MaxLen ( 256 )
Key
string SystemName ;
The Name of the scoping System.
MaxLen ( 10 )
Deprecated { "CIM_Service.EnabledDefault" }
ValueMap { "Automatic" , "Manual" }
string StartMode ;
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.
uint32StartService()
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.
uint32StopService()
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.
Propagated ( "CIM_System.CreationClassName" )
MaxLen ( 256 )
Key
string SystemCreationClassName ;
The CreationClassName of the scoping System.
MaxLen ( 256 )
Override ( "Name" )
Key
string Name ;
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.
MaxLen ( 256 )
Write
MappingStrings { "MIF.DMTF|General Information|001.4" }
string PrimaryOwnerContact ;
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).
MaxLen ( 256 )
Key
string CreationClassName ;
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.
MaxLen ( 64 )
Write
MappingStrings { "MIF.DMTF|General Information|001.3" }
string PrimaryOwnerName ;
The name of the primary owner for the service, if one is defined. The primary owner is the initial support contact for the Service.
ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" }
string OtherEnabledState ;
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.
Values { "Unknown" , "Other" , "Enabled" , "Disabled" , "Shutting Down" , "Not Applicable" , "Enabled but Offline" , "In Test" , "Deferred" , "Quiesce" , "Starting" , "DMTF Reserved" , "Vendor Reserved" }
ModelCorrespondence { "CIM_EnabledLogicalElement.OtherEnabledState" }
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11..32767" , "32768..65535" }
uint16 EnabledState = 5 ;
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.
datetime TimeOfLastStateChange ;
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.
Values { "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 Specific" }
ModelCorrespondence { "CIM_EnabledLogicalElement.RequestedState" }
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "4096" , "4097" , "4098" , "4099" , "4100..32767" , "32768..65535" }
uint32RequestStateChange(
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.
Qualifiers:Values { "Enabled" , "Disabled" , "Shut Down" , "Offline" , "Test" , "Defer" , "Quiesce" , "Reboot" , "Reset" , "DMTF Reserved" , "Vendor Reserved" } IN ModelCorrespondence { "CIM_EnabledLogicalElement.RequestedState" } ValueMap { "2" , "3" , "4" , "6" , "7" , "8" , "9" , "10" , "11" , ".." , "32768..65535" }
uint16 RequestedState
Reference to the job (can be null if the task is completed).
Qualifiers:OUT IN ( false )
CIM_ConcreteJob REF Job
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.

Qualifiers:IN
datetime TimeoutPeriod
)
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.
Values { "Enabled" , "Disabled" , "Shut Down" , "No Change" , "Offline" , "Test" , "Deferred" , "Quiesce" , "Reboot" , "Reset" , "Not Applicable" , "DMTF Reserved" , "Vendor Reserved" }
ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" }
ValueMap { "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , ".." , "32768..65535" }
uint16 RequestedState = 12 ;
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.
Values { "Enabled" , "Disabled" , "Not Applicable" , "Enabled but Offline" , "No Default" , "DMTF Reserved" , "Vendor Reserved" }
Write
ValueMap { "2" , "3" , "5" , "6" , "7" , "8..32767" , "32768..65535" }
uint16 EnabledDefault = 2 ;
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).
ModelCorrespondence { "CIM_ManagedSystemElement.OperationalStatus" }
ArrayType ( "Indexed" )
string StatusDescriptions [ ] ;
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.
Values { "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 Reserved" }
ModelCorrespondence { "CIM_ManagedSystemElement.StatusDescriptions" }
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , "15" , "16" , "17" , "18" , ".." , "0x8000.." }
ArrayType ( "Indexed" )
uint16 OperationalStatus [ ] ;
Indicates the current status(es) of the element. Various health and operational statuses are defined. Many of the enumeration's values are self- explanatory. However, a few are not and are described in more detail.
'Stressed' indicates that the element is functioning, but needs attention. Examples of 'Stressed' states are overload, overheated, etc.
'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 element's state and configuration may need to be updated.
'Dormant' indicates that the element is inactive or quiesced.
'Supporting Entity in Error' describes that this element may 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 the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can till if the complete operation passed (Completed with OK), and failure (Completed with Error). Completed with Degraded would imply the operation finished, but did not complete OK or report an error.
'Power Mode' indicates 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 since it required the DEPRECATED qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly RECOMMENDED that providers/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 (since it is single-valued) SHOULD also provide the primary status of the element.
MappingStrings { "MIF.DMTF|ComponentID|001.5" }
datetime InstallDate ;
A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.
MaxLen ( 10 )
Deprecated { "CIM_ManagedSystemElement.OperationalStatus" }
ValueMap { "OK" , "Error" , "Degraded" , "Unknown" , "Pred Fail" , "Starting" , "Stopping" , "Service" , "Stressed" , "NonRecover" , "No Contact" , "Lost Comm" , "Stopped" }
string Status ;
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 overcomes the limitation of describing status via a single value, when it is really a multi-valued property (for example, an element may be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. And, 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.
MaxLen ( 64 )
string Caption ;
The Caption property is a short textual description (one- line string) of the object.
string Description ;
The Description property provides a textual description of the object.
string ElementName ;
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.