ShowMetrics method of the CIM_MetricService class

Reports the following: the metrics available to be collected for a managed element, the managed elements 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 managed element.

Syntax

uint32 ShowMetrics(
  [in]  CIM_ManagedElement       REF Subject,
  [in]  CIM_BaseMetricDefinition REF Definition,
  [out] CIM_ManagedElement       REF ManagedElements[],
  [out] CIM_BaseMetricDefinition REF DefinitionList[],
  [out] string                       MetricNames[],
  [out] uint16                       MetricCollectionEnabled[]
);

Parameters

Subject [in]

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.

Definition [in]

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.

ManagedElements [out]

On success, may contain references to CIM_ManagedElement objects for which the metric identified by the Definition parameter is available for collection.

DefinitionList [out]

On success, may contain references to instances of CIM_BaseMetricDefinition objects that define metrics available for collection for the CIM_ManagedElement identified by the Subject parameter.

MetricNames [out]

On success, each array index shall contain the value of the Name property for the instance of CIM_BaseMetricDefinition referenced by the corresponding array index of the DefinitionList parameter.

MetricCollectionEnabled [out]

Indicates whether a metric is being collected for a managed element.

Enable (2)

Disable (3)

Reserved (4)

DMTF Reserved (..)

Vendor Reserved (32768..65535)

Return value

Returns a 0 on success; otherwise, returns an error.

Success (0)

Not Supported (1)

Failed (2)

Method Reserved (..)

Vendor Specific (32768..65535)

Requirements

See also

CIM_MetricService