cim_diagnostictest.mof

Pegasus is an open-source implementationof the DMTF CIM and WBEM standards. It is designed to be por

          "2 = Not Implemented (function is not implemented for this "
          "instance) \n"
          "3 = Out Of Resources (component could not allocate required "
          "resources, e.g. memory, disk space, etc.) \n"
          "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.")]
   uint32 RunTest( 
         [IN, Description (
             "The ManagedSystemElement on which the test will run.")]
      CIM_ManagedSystemElement REF SystemElement, 
         [IN, Description (
             "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.")]
      CIM_DiagnosticSetting REF Setting, 
         [IN ( false ), OUT, Description (
             "Results of the test are stored in a DiagnosticResult "
             "object, a reference to which is returned as the Result "
             "output parameter.")]
      CIM_DiagnosticResult REF Result); 


      [Deprecated { "CIM_Log.ClearLog" }, Description (
          "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. \n"
          "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. \n"
          "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. "
          "\nThe method's return codes are expected to adhere to the "
          "XML return codes as they are introduced. Currently, the "
          "standard return values are: \n"
          "0 = OK (function succeeded, but the test itself may have "
          "failed) \n"
          "1 = Unspecified Error (function failed for unspecified "
          "reasons) \n"
          "2 = Not Implemented (function is not implemented for this "
          "instance) \n"
          "3 = Out Of Resources (component could not allocate required "
          "resources, e.g. memory, disk space, etc.) \n"
          "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.")]
   uint32 ClearResults( 
         [IN, Description (
             "The Managed System Element for which results will be "
             "cleared.")]
      CIM_ManagedSystemElement REF SystemElement, 
         [IN ( false ), OUT, Description (
             "A string array that lists the keys of the "
             "DiagnosticResults which could not be deleted.")]
      string ResultsNotCleared[]); 


      [Deprecated { "CIM_ConcreteJob.RequestStateChange" }, 
       Description (
          "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: \n"
          "Set to TRUE if testing was successfully stopped. \n"
          "Set to FALSE if the current test(s) can not be stopped. \n"
          "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). \n"
          "The method's return codes are expected to adhere to the XML "
          "return codes as they are introduced. Currently, the "
          "standard return values are: \n"
          "0 = OK (function succeeded, but the test itself may have "
          "failed \n"
          "1 = Unspecified Error (function failed for unspecified "
          "reasons) \n"
          "2 = Not Implemented (function is not implemented for this "
          "instance) \n"
          "3 = Out Of Resources (component could not allocate required "
          "resources, e.g. memory, disk space, etc.) \n"
          "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.")]
   uint32 DiscontinueTest( 
         [IN, Description (
             "Testing will be discontinued for the indicated "
             "ManagedSystemElement defined by the SystemElement input "
             "parameter.")]
      CIM_ManagedSystemElement REF SystemElement, 
         [IN, Description (
             "The test to discontinue is specified using the Result "
             "input parameter.")]
      CIM_DiagnosticResult REF Result, 
         [IN ( false ), OUT, Description (
             "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).")]
      boolean TestingStopped); 

      [Description (
          "The descriptions for each test type are below: \n"
          "\n"
          "* If \"Functional\" (value=2) is set, this tests one, more "
          "or all the functionality of the element. \n"
          "\n"
          "* If \"Stress\" (value=3) is set, this test is a stress "
          "test or exerciser for the element. \n"
          "\n"
          "* If \"Health Check\" (value=4) is set, this test validates "
          "the current health of the element. \n"
          "\n"
          "* 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. \n"
          "\n"
          "* 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."), 
       ValueMap { "0", "1", "2", "3", "4", "5", "6", "..", "0x8000.." }, 
       Values { "Unknown", "Other", "Functional", "Stress",
          "Health Check", "Access Test", "Media Verify",
          "DMTF Reserved", "Vendor Reserved" }, ArrayType ( "Indexed" ), 
       ModelCorrespondence { 
          "CIM_DiagnosticTest.OtherTestTypesDescriptions" }]
   uint16 TestTypes[];

      [Description (
          "OtherTestTypesDescriptions is an array that contains an "
          "element with additional information for each TestTypes "
          "element with a value of 1 (\"Other\")."), 
       ArrayType ( "Indexed" ), 
       ModelCorrespondence { "CIM_DiagnosticTest.TestTypes" }]
   string OtherTestTypesDescriptions[];

};