ControlMetrics method of the CIM_MetricService class
Enables and disables the collection of metrics.ControlMetrics 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 managed elements, or the collection of a specific metric for a specific managed element.
Syntax
uint32 ControlMetrics(
[in] CIM_ManagedElement REF Subject,
[in] CIM_BaseMetricDefinition REF Definition,
[in] uint16 MetricCollectionEnabled
);
Parameters
-
Subject [in]
-
A CIM_ManagedElement that identifies managed element(s) for which metrics will be controlled.
-
Definition [in]
-
Identifies a CIM_BaseMetricDefinition for which metrics will be controlled.
-
MetricCollectionEnabled [in]
-
Indicates the desired operation to perform on the metrics.
-
Enable (2)
-
Disable (3)
-
Reset (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
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows 8.1 |
| Minimum supported server |
Windows Server 2012 R2 |
| Namespace |
Root\virtualization\v2 |
| MOF |
|
| DLL |
|