(file) Return to CIM_MetricService.mof CVS log (file) (dir) Up to [Pegasus] / pegasus / Schemas / CIM231 / DMTF / Metrics

Diff for /pegasus/Schemas/CIM231/DMTF/Metrics/CIM_MetricService.mof between version 1.1.2.1 and 1.1.2.2

version 1.1.2.1, 2012/01/24 13:50:18 version 1.1.2.2, 2012/02/15 17:46:33
Line 0 
Line 1 
   // Copyright (c) 2009 DMTF.  All rights reserved.
      [Version ( "2.23.0" ),
       UMLPackagePath ( "CIM::Metrics::BaseMetric" ),
       Description (
          "CIM_MetricService provides the ability to manage metrics. For "
          "each metric that the service manages, there shall be an "
          "instance of CIM_ServiceAffectsElement that associates the "
          "CIM_MetricService to the instance of CIM_BaseMetricDefinition "
          "that defines the metric, where the value of the "
          "CIM_ServiceAffectsElement.ElementAffects property is 5 "
          "\"Manages\". The capabilities of the CIM_MetricService "
          "instance are advertised through an instance of "
          "CIM_MetricServiceCapabilities associated with the "
          "CIM_MetricService instance through CIM_ElementCapabilities." )]
   class CIM_MetricService : CIM_Service {
   
   
         [Description (
             "ShowMetrics reports the Metrics available to be "
             "collected for a ManagedElement, the ManagedElements for "
             "which a metric defined by an instance of "
             "CIM_BaseMetricDefinition is available to be collected, "
             "and whether or not a particular metric is currently "
             "being collected for a ManagedElement. \n"
             "If the Subject parameter is specified and the Definition "
             "parameter is NULL, upon successful completion of the "
             "method, the DefinitionList[] parameter shall contain a "
             "reference to an instance of CIM_BaseMetricDefinition for "
             "each instance of CIM_BaseMetricDefinition to which the "
             "instance of CIM_ManagedElement identified by the Subject "
             "parameter is associated through CIM_MetricDefForME where "
             "the CIM_BaseMetricDefinition instance is associated to "
             "the CIM_MetricService instance through "
             "CIM_ServiceAffectsElement, the MetricCollectionEnabled "
             "parameter shall contain a value corresponding to the "
             "value of the MetricCollectionEnabled property of the "
             "instance of CIM_MetricDefForME that associates the "
             "CIM_ManagedElement identified by the Subject parameter "
             "with the CIM_BaseMetricDefinition for which a reference "
             "is returned in the DefinitionList parameter at the same "
             "array index.\n"
             "If the Definition parameter is non-NULL and the Subject "
             "parameter is NULL, upon successful completion of the "
             "method the ManagedElements parameter shall contain a "
             "reference to each CIM_ManagedElement instance to which "
             "the CIM_BaseMetricDefinition instance referenced by the "
             "Definition parameteris associated through "
             "CIM_MetricDefForME and the MetricCollectionEnabled "
             "parameter shall contain a value corresponding to the "
             "value of the MetricCollectionEnabled property of the "
             "instance of CIM_MetricDefForME that associates the "
             "CIM_BaseMetricDefinition identified by the Definition "
             "parameter with the CIM_ManagedElement for which a "
             "reference is returned in the ManagedElements parameter "
             "at the same array index as the reference to the CIM_ManagedElement.\n"
             "If the Subject parameter and Definition parameter are "
             "both non-NULL, the method shall return NULL values for "
             "the DefinitionList and ManagedElements parameters, and "
             "the MetricCollectionEnabled parameter shall contain a "
             "single value that corresponds to the value of the "
             "MetricCollectionEnabled property of the instance of "
             "CIM_MetricDefForME that associates the instance of "
             "CIM_ManagedElement identified by the Subject parameter "
             "with the instance of CIM_BaseMetricDefinition identified "
             "by the Definition parameter. If the Subject and "
             "Definition parameters are both NULL, the method shall "
             "return 2 \"Failed\". If the Definition parameter is a "
             "reference to an instance of CIM_BaseMetricDefinition "
             "that is not associated to the CIM_MetricService through "
             "CIM_ServiceAffectsElement, the method shall return 2 "
             "\"Failed\". If the Subject parameter does not identify a "
             "single instance the Method shall return 2 \"Failed\"." ),
          ValueMap { "0", "1", "2", "..", "32768..65535" },
          Values { "Success", "Not Supported", "Failed",
             "Method Reserved", "Vendor Specific" }]
      uint32 ShowMetrics(
            [IN, Description (
                "The Subject parameter identifies an instance of "
                "CIM_ManagedElement for which the method returns "
                "references to instances of "
                "CIM_BaseMetricDefinition that define metrics that "
                "are being captured for the CIM_ManagedElement." )]
         CIM_ManagedElement REF Subject,
            [IN, Description (
                "The Definition parameter identifies an instance of "
                "CIM_BaseMetricDefintion. The method returns "
                "references to instances of CIM_ManagedElement for "
                "which metrics defined by the instance of "
                "CIM_BaseMetricDefinition are available to be "
                "collected." )]
         CIM_BaseMetricDefinition REF Definition,
            [IN ( false ), OUT, Description (
                "Upon successful completion of the method, the "
                "ManagedElements[] parameter may contain references "
                "to CIM_ManagedElements for which the metric "
                "identified by Definition parameter is available "
                "for collection." ),
             ArrayType ( "Indexed" ),
             ModelCorrespondence {
                "CIM_MetricService.ShowMetrics.DefinitionList" }]
         CIM_ManagedElement REF ManagedElements[],
            [IN ( false ), OUT, Description (
                "Upon successful completion of the method, the "
                "DefinitionList parameter may contain references to "
                "instances of CIM_BaseMetricDefinitions that define "
                "metrics available for collection for the "
                "CIM_ManagedElement identified by the Subject "
                "parameter." ),
             ArrayType ( "Indexed" ),
             ModelCorrespondence {
                "CIM_MetricService.ShowMetrics.ManagedElements" }]
         CIM_BaseMetricDefinition REF DefinitionList[],
            [IN ( false ), OUT, Description (
                "Upon successful completion of the method, each "
                "array index of the MetricNames parameter shall "
                "contain the value of the Name property for the "
                "instance of CIM_BaseMetricDefinition referenced by "
                "the corresponding array index of the "
                "DefinitionList parameter." ),
             ArrayType ( "Indexed" ),
             ModelCorrespondence {
                "CIM_MetricService.ShowMetrics.DefinitionList" }]
         string MetricNames[],
            [IN ( false ), OUT, Description (
                "The MetricCollectionEnabled parameter indicates "
                "whether a metric is being collected for a managed "
                "element." ),
             ValueMap { "2", "3", "4", "..", "32768..65535" },
             Values { "Enable", "Disable", "Reserved",
                "DMTF Reserved", "Vendor Reserved" }]
         uint16 MetricCollectionEnabled[]);
   
         [Description (
             "ShowMetricsByClass reports the Metrics available to be "
             "collected for all instances of a CIM class. The CIM "
             "classes for which a metric defined by an instance of "
             "CIM_BaseMetricDefinition is available to be collected, "
             "and whether or not a particular metric is currently "
             "being collected for a ManagedElement. \n"
             "If the Subject parameter is specified and the Definition "
             "parameter is NULL, upon successful completion of the "
             "method, the DefinitionList[] parameter shall contain a "
             "reference to an instance of CIM_BaseMetricDefinition for "
             "each instance of CIM_BaseMetricDefinition that is "
             "associated with all instances of the class identified by "
             "the Subject parameter, where the "
             "CIM_BaseMetricDefinition instance is associated to the "
             "CIM_MetricService instance through "
             "CIM_ServiceAffectsElement; the MetricCollectionEnabled "
             "parameter shall contain the value 2 \"Enabled\" if the "
             "value of the MetricCollectionEnabled property has the "
             "value 2 \"Enabled\" for every instance of "
             "CIM_MetricDefForME that associates the "
             "CIM_ManagedElement identified by the Subject parameter "
             "with the CIM_BaseMetricDefinition for which a reference "
             "CIM_BaseMetricDefinition is returned in the "
             "DefinitionList parameter at the same array index as the "
             "reference and the MetricCollectionEnabled parameter "
             "shall contain the value 3 \"Disabled\" if the value of "
             "the MetricCollectionEnabled property does not have the "
             "value 2 \"Enabled\" for every instance of "
             "CIM_MetricDefForME that associates the "
             "CIM_ManagedElement identified by the Subject parameter "
             "with the CIM_BaseMetricDefinition for which a reference "
             "CIM_BaseMetricDefinition is returned in the "
             "DefinitionList parameter at the same array index as the "
             "reference. \n"
             "If the Subject parameter and Definition parameter are "
             "both non-NULL, the method shall return NULL value for "
             "the DefinitionList parameter and the "
             "MetricCollectionEnabled parameter shall contain a single "
             "value that corresponds to the value of the "
             "MetricCollectionEnabled property of the instance of "
             "CIM_MetricDefForME that associates the instance of "
             "CIM_ManagedElement identified by the Subject parameter "
             "with the instance of CIM_BaseMetricDefinition identified "
             "by the Definition parameter. If the Subject and "
             "Definition parameters are both NULL, the method shall "
             "return 2 \"Failed\". If the Definition parameter is a "
             "reference to an instance of CIM_BaseMetricDefinition "
             "that is not associated to the CIM_MetricService through "
             "CIM_ServiceAffectsElement, the method shall return 2 "
             "\"Failed\". If the Subject parameter does not identify a "
             "single CIM Class the Method shall return 2 \"Failed\"." ),
          ValueMap { "0", "1", "2", "..", "32768..65535" },
          Values { "Success", "Not Supported", "Failed",
             "Method Reserved", "Vendor Specific" }]
      uint32 ShowMetricsByClass(
            [Required, IN, Description (
                "The Subject parameter identifies a CIM class for "
                "which the method returns references to instances "
                "of CIM_BaseMetricDefinition that define metrics "
                "that are available to be captured for all "
                "instances of the class." )]
         CIM_ManagedElement REF Subject,
            [IN, Description (
                "The Definition parameter identifies an instance of "
                "CIM_BaseMetricDefinition. The method returns "
                "references to instances of CIM_ManagedElement for "
                "which metrics defined by the instance of "
                "CIM_BaseMetricDefinition are available to be "
                "collected." )]
         CIM_BaseMetricDefinition REF Definition,
            [IN ( false ), OUT, Description (
                "Upon successful completion of the method, the "
                "DefinitionList parameter may contain references to "
                "instances of CIM_BaseMetricDefinitions that define "
                "metrics available for collection for the "
                "CIM_ManagedElement identified by the Subject "
                "parameter." ),
             ArrayType ( "Indexed" ),
             ModelCorrespondence {
                "CIM_MetricService.ShowMetricsByClass.ManagedElements" }]
         CIM_BaseMetricDefinition REF DefinitionList[],
            [IN ( false ), OUT, Description (
                "Upon successful completion of the method, each "
                "array index of the MetricNames parameter shall "
                "contain the value of the Name property for the "
                "instance of CIM_BaseMetricDefinition referenced by "
                "the corresponding array index of the "
                "DefinitionList parameter." ),
             ArrayType ( "Indexed" ),
             ModelCorrespondence {
                "CIM_MetricService.ShowMetricsByClass.DefinitionList" }]
         string MetricNames[],
            [IN ( false ), OUT, Description (
                "The MetricCollectionEnabled parameter indicates "
                "whether a metric is being collected for all "
                "instances of a class of managed elements." ),
             ValueMap { "2", "3", "4", "..", "32768..65535" },
             Values { "Enabled", "Disabled", "Reserved",
                "DMTF Reserved", "Vendor Reserved" }]
         uint16 MetricCollectionEnabled[]);
   
         [Description (
             "ControlMetrics enables and disables the collection of "
             "metrics. It is used to control the collection of each "
             "type of metric for a CIM_ManagedElement, the collection "
             "of a given type of metric for all ManagedElements, or "
             "the collection of a specific metric for a specific "
             "ManagedElement. \n"
             "If the Subject parameter is specified and the Definition "
             "parameter is NULL and the MetricCollectionEnabled "
             "parameter has the value 2 \"Enabled\" or 3 \"Disabled\", "
             "upon successful completion of the method, the "
             "MetricCollectionEnabled property of each instance of "
             "CIM_MetricDefForME that references the instance of "
             "CIM_ManagedElement identified by the Subject parameter "
             "and references an instance of CIM_BaseMetricDefinition "
             "that is associated to the CIM_BaseMetricService through "
             "the CIM_ServiceAffectsElement association shall have the "
             "value of the MetricCollectionEnabled parameter. If the "
             "Subject parameter is specified and the Definition "
             "parameter is NULL and the value of the "
             "MetricCollectionEnabled parameter is 4 \"Reset\" upon "
             "successful completion of the method, the value of the "
             "MetricCollectionEnabled of each instance of "
             "CIM_MetricDefForME that references the instance of "
             "CIM_ManagedElement identified by the Subject parameter "
             "and references an instance of CIM_BaseMetricDefinition "
             "that is associated to the CIM_BaseMetricService through "
             "the CIM_ServiceAffectsElement association shall "
             "transition to 3 \"Disabled\" then to 2 \"Enabled\". If "
             "the Definition parameter is non-NULL and the Subject "
             "parameter is NULL, and the MetricCollectionEnabled "
             "parameter has the value 2 \"Enabled\" or 3 \"Disabled\", "
             "upon successful completion of the method the "
             "MetricCollectionEnabled property of each instance of "
             "CIM_MetricDefForME that references the instance of "
             "CIM_BaseMetricDefinition identified by the Definition "
             "parameter shall have the value of the "
             "MetricCollectionEnabled parameter. If the Definition "
             "parameter is non-NULL and the Subject parameter is NULL, "
             "and the value of the MetricCollectionEnabled parameter "
             "is 4 \"Reset\" upon successful completion of the method "
             "the MetricCollectionEnabled property of each instance of "
             "CIM_MetricDefForME that references the instance of "
             "CIM_BaseMetricDefinition identified by the Definition "
             "parameter shall transition to 3 \"Disabled\" then to 2 "
             "\"Enabled\". If the Subject parameter and Definition "
             "parameter are both non-NULL, and the "
             "MetricCollectionEnabled parameter has the value 2 "
             "\"Enable\" or 3 \"Disable\", upon successful completion "
             "of the method, the MetricCollectionEnabled property of "
             "the instance of CIM_MetricDefForME that references the "
             "instance of CIM_ManagedElement identified by the Subject "
             "parameter and references the instance of "
             "CIM_BaseMetricDefinition identified by the Definition "
             "parameter shall have the value of the "
             "MetricCollectionEnabled parameter.\n"
             "If the Subject parameter and Definition parameter are "
             "both non-NULL and the value of the "
             "MetricCollectionEnabled parameter is 4 \"Reset\" upon "
             "successful completion of the method, the "
             "MetricCollectionEnabled property of the instance of "
             "CIM_MetricDefForME that references the instance of "
             "CIM_ManagedElement identified by the Subject parameter "
             "and references the instance of CIM_BaseMetricDefinition "
             "identified by the Definition parameter shall transition "
             "to 3 \"Disabled\" then to 2 \"Enabled\". If the Subject "
             "parameter and Definition parameter are both non-NULL and "
             "there is not an instance of CIM_MetricDefForME that "
             "associates the two instances, the method shall return 2 "
             "\"Failed\". If the Subject and Definition parameters are "
             "both NULL, the method shall return 2 \"Failed\". If the "
             "Definition parameter is a reference to an instance of "
             "CIM_BaseMetricDefinition that is not associated to the "
             "CIM_MetricService through CIM_ServiceAffectsElement, the "
             "method shall return 2 \"Failed\". If the Subject "
             "parameter does not identify a single instance the Method "
             "shall return 2 \"Failed\"." ),
          ValueMap { "0", "1", "2", "..", "32768..65535" },
          Values { "Success", "Not Supported", "Failed",
             "Method Reserved", "Vendor Specific" }]
      uint32 ControlMetrics(
            [IN, Description (
                "The Subject parameter identifies managed "
                "element(s) for which metrics will be controlled." )]
         CIM_ManagedElement REF Subject,
            [IN, Description (
                "The Definition parameter identifies a "
                "CIM_BaseMetricDefinition for which metrics will be "
                "controlled." )]
         CIM_BaseMetricDefinition REF Definition,
            [Required, IN, Description (
                "The MetricCollectionEnabled parameter indicates "
                "the desired operation to perform on the metrics." ),
             ValueMap { "2", "3", "4", "..", "32768..65535" },
             Values { "Enable", "Disable", "Reset", "DMTF Reserved",
                "Vendor Reserved" }]
         uint16 MetricCollectionEnabled);
   
         [Description (
             "ControlMetricsByClass enables and disables the "
             "collection of metrics. It is used to control the "
             "collection of each type of metric for all instances of a "
             "class or the collection of a specific metric for all "
             "instances of a class. \n"
             "If the Definition parameter is NULL, and the "
             "MetricCollectionEnabled parameter has the value 2 "
             "\"Enabled\" or 3 \"Disabled\", upon successful "
             "completion of the method, the MetricCollectionEnabled "
             "property of each instance of CIM_MetricDefForME that "
             "references an instance of the class identified by the "
             "Subject parameter and references an instance of "
             "CIM_BaseMetricDefinition that is associated to the "
             "CIM_BaseMetricService through the "
             "CIM_ServiceAffectsElement association shall have the "
             "value of the MetricCollectionEnabled parameter. If the "
             "Definition parameter is NULL, and the "
             "MetricCollectionEnabled parameter has the value 4 "
             "\"Reset\", upon successful completion of the method, the "
             "MetricCollectionEnabled property of each instance of "
             "CIM_MetricDefForME that references an instance of the "
             "class identified by the Subject parameter and references "
             "an instance of CIM_BaseMetricDefinition that is "
             "associated to the CIM_BaseMetricService through the "
             "CIM_ServiceAffectsElement association shall transition "
             "to 3 \"Disabled\" then to 2 \"Enabled\". If the "
             "Definition parameter is non-NULL, and the "
             "MetricCollectionEnabled parameter has the value 2 "
             "\"Enable\" or 3 \"Disable\", upon successful completion "
             "of the method the MetricCollectionEnabled property of "
             "each instance of CIM_MetricDefForME that references the "
             "instance of CIM_BaseMetricDefinition identified by the "
             "Definition parameter and references an instance of the "
             "class identified by the Subject parameter shall have the "
             "value of the MetricCollectionEnabled parameter. If the "
             "Definition parameter is non-NULL, and the "
             "MetricCollectionEnabled parameter has the value 4 "
             "\"Reset\", upon successful completion of the method the "
             "MetricCollectionEnabled property of each instance of "
             "CIM_MetricDefForME that references the instance of "
             "CIM_BaseMetricDefinition identified by the Definition "
             "parameter and references an instance of the class "
             "identified by the Subject parameter shall transition to "
             "3 \"Disabled\" then to 2 \"Enabled\". For each instance "
             "of the class identified by the Subject parameter, if "
             "there is not an instance of CIM_MetricDefForME that "
             "associates the CIM_BaseMetricDefinition instance "
             "identified by the Definition parameter to the instance, "
             "the method shall return 2 \"Failed\". If the Subject and "
             "Definition parameters are both NULL, the method shall "
             "return 2 \"Failed\". If the Definition parameter is a "
             "reference to an instance of CIM_BaseMetricDefinition "
             "that is not associated to the CIM_MetricService through "
             "CIM_ServiceAffectsElement, the method shall return 2 "
             "\"Failed\". If the Subject parameter does not identify a "
             "single CIM Class the Method shall return 2 \"Failed\"." ),
          ValueMap { "0", "1", "2", "..", "32768..65535" },
          Values { "Success", "Not Supported", "Failed",
             "Method Reserved", "Vendor Specific" }]
      uint32 ControlMetricsByClass(
            [Required, IN, Description (
                "The Subject parameter identifies the CIM class for "
                "which metrics will be controlled." )]
         CIM_ManagedElement REF Subject,
            [IN, Description (
                "The Definition parameter identifies a "
                "CIM_BaseMetricDefinition for which metrics will be "
                "controlled." )]
         CIM_BaseMetricDefinition REF Definition,
            [Required, IN, Description (
                "The MetricCollectionEnabled parameter indicates "
                "the desired operation to perform on the metrics." ),
             ValueMap { "2", "3", "4", "..", "32768..65535" },
             Values { "Enable", "Disable", "Reset", "DMTF Reserved",
                "Vendor Reserved" }]
         uint16 MetricCollectionEnabled);
   
         [Description (
             "GetMetricValues provides the ability to return a "
             "filtered list of CIM_BaseMetricValue instances. \n"
             "If the Definition parameter is NULL, the method shall "
             "return 2 \"Failed\". If the Definition parameter is a "
             "reference to an instance of CIM_BaseMetricDefinition "
             "with which the CIM_MetricService is not associated "
             "through CIM_ServiceAffectsElement, the method shall "
             "return 2 \"Failed\"." ),
          ValueMap { "0", "1", "2", "..", "32768..65535" },
          Values { "Success", "Not Supported", "Failed",
             "Method Reserved", "Vendor Specific" }]
      uint32 GetMetricValues(
            [Required, IN, Description (
                "The Definition parameter identifies a "
                "CIM_BaseMetricDefinition for which metrics will be "
                "returned." )]
         CIM_BaseMetricDefinition REF Definition,
            [IN, Description (
                "The Range parameter identifies how the instances "
                "are selected. The algorithm for ordering value "
                "instances is metric definition specific." ),
             ValueMap { "2", "3", "..", "32768..65535" },
             Values { "Minimum", "Maximum", "DMTF Reserved",
                "Vendor Specific" }]
         uint16 Range,
            [IN, Description (
                "The Count parameter identifies the maximum number "
                "of instances to to be returned by the method." )]
         uint16 Count,
            [IN ( false ), OUT, Description (
                "Upon successful completion of the method, the "
                "Values parameter contains references to instances "
                "of CIM_BaseMetricValue, filteredaccording to the "
                "values of the input parameters." ),
             ArrayType ( "Indexed" ),
             ModelCorrespondence {
                "CIM_MetricService.ShowMetrics.ManagedElements" }]
         CIM_BaseMetricValue REF Values[]);
   
         [Description (
             "Method used to allow specification of the point in time "
             "metric gathering is to be started and to specify the "
             "preferred sample interval time for periodic data "
             "gathering. \n"
             "Whenever sampling for additional metrics is started, the "
             "settings specified by this method may be used." ),
          ValueMap { "0", "1", "2", "..", "32768..65535" },
          Values { "Success", "Not Supported", "Failed",
             "Method Reserved", "Vendor Specific" }]
      uint32 ControlSampleTimes(
            [Required, IN, Description (
                "Point in time when sampling for the metrics is to "
                "be started. \n"
                "A value of 99990101000000.000000+000 shall "
                "indicate that sampling should start at the next "
                "time it is synchronized to the full hour. Sampling "
                "is synchronized to the full hour if seconds since "
                "midnight modulo sample interval in seconds is "
                "equal to 0." )]
         datetime StartSampleTime,
            [Required, IN, Description (
                "Preferred sample interval time. In order to get "
                "correlatable metrics, it is recommended that the "
                "sample interval be chosen in a way that 3600 "
                "modulo sample interval time in seconds is equal to "
                "0. \n"
                "It is the responsibility of the CIM metric service "
                "implementation to decide whether the requested "
                "sample interval time is honored. \n"
                "The CIM client can check whether or not the metric "
                "providers are honoring the requested sample "
                "interval time by retrieving related "
                "BaseMetricDefinition instances and checking the "
                "contents of the "
                "\"CIM_BaseMetricDefinition.SampleInterval\" "
                "property." )]
         datetime PreferredSampleInterval,
            [Required, IN, Description (
                "Boolean that when set to TRUE requests that "
                "gathering of all metrics associated to the metric "
                "service is re-started with this method call." )]
         boolean RestartGathering);
   
   };

Legend:
Removed from v.1.1.2.1  
changed lines
  Added in v.1.1.2.2
No CVS admin address has been configured
 Powered by
ViewCVS 0.9.2